Package com.microstrategy.web.objects
Interface WebMDUpdateSource
-
public interface WebMDUpdateSource
Object used to perform update manipulations on the MetaData- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description java.lang.String
getCurrentVersion()
Return the current version of the MD connected to by the IServer.java.lang.String
getLogPath()
Return the path where a log will be stored upon updateboolean
needMDXUpdate(boolean quickCheck)
Check to see if the current MD needs to update its MDX componentsboolean
needUpdate()
Returns whether the current MD needs to be updated to work optimally with the current version of the MSTR product.void
setLogPath(java.lang.String logPath)
Set the path where a log of the update can be storedjava.lang.String
update(int command)
Send a custom update commandjava.lang.String
update(int command, int fg)
Send a custom update commandvoid
updateDocDefns()
Deprecated.useupdate(int)
insteadvoid
updateHistoryListSchedules()
Update the MD History List schedulesvoid
updateIncrementalPrivileges(int privTypes)
Update privileges as specifiedvoid
updateMD()
Updates the entire MD to a version that will work with the current version of the MSTR product.void
updateProject()
Updates the project currently associated with the IServer session.void
updateSecurityModel()
Update the MD security modelvoid
updateTranslations()
Update the translations stored in MD
-
-
-
Method Detail
-
getCurrentVersion
java.lang.String getCurrentVersion() throws WebObjectsException
Return the current version of the MD connected to by the IServer. Not optimized: Each call will result in a call to IServer- Returns:
String
containing the current version of the MD- Throws:
WebObjectsException
-
needUpdate
boolean needUpdate() throws WebObjectsException
Returns whether the current MD needs to be updated to work optimally with the current version of the MSTR product. Not optimized: Each call will result in a call to IServer- Returns:
- boolean stating whether an update is needed (true if yes, false if no)
- Throws:
WebObjectsException
-
updateMD
void updateMD() throws WebObjectsException
Updates the entire MD to a version that will work with the current version of the MSTR product.- Throws:
WebObjectsException
-
updateProject
void updateProject() throws WebObjectsException
Updates the project currently associated with the IServer session. Exception is thrown if this method is called with a configuration session- Throws:
WebObjectsException
-
updateSecurityModel
void updateSecurityModel() throws WebObjectsException
Update the MD security model- Throws:
WebObjectsException
-
updateDocDefns
void updateDocDefns() throws WebObjectsException
Deprecated.useupdate(int)
insteadUpdate the MD document definitions- Throws:
WebObjectsException
-
updateHistoryListSchedules
void updateHistoryListSchedules() throws WebObjectsException
Update the MD History List schedules- Throws:
WebObjectsException
-
updateTranslations
void updateTranslations() throws WebObjectsException
Update the translations stored in MD- Throws:
WebObjectsException
-
setLogPath
void setLogPath(java.lang.String logPath)
Set the path where a log of the update can be stored- Parameters:
logPath
-String
containing the path information
-
getLogPath
java.lang.String getLogPath()
Return the path where a log will be stored upon update- Returns:
String
containing path information
-
update
java.lang.String update(int command) throws WebObjectsException
Send a custom update command- Parameters:
command
- int fromEnumDSSXMLMDUpdateCommands
specifiying which command to send to the IServer- Returns:
- String containing results of the command
- Throws:
WebObjectsException
-
update
java.lang.String update(int command, int fg) throws WebObjectsException
Send a custom update command- Parameters:
command
- int fromEnumDSSXMLMDUpdateCommands
specifiying which command to send to the IServercommand
- int fromEnumDSSXMLMDUpdateCommands
specifiying an IServer flag- Returns:
- String containing results of the command
- Throws:
WebObjectsException
-
needMDXUpdate
boolean needMDXUpdate(boolean quickCheck) throws WebObjectsException
Check to see if the current MD needs to update its MDX components- Returns:
- boolean true if update is required and false if update is not required or no MDX components exist
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.1
-
updateIncrementalPrivileges
void updateIncrementalPrivileges(int privTypes) throws WebObjectsException
Update privileges as specified- Parameters:
privTypes
- int binary OR ofEnumDSSXMLPrivilegeUpdateTypes
- Throws:
WebObjectsException
-
-