public interface

WebMDUpdateSource

com.microstrategy.web.objects.WebMDUpdateSource

Class Overview

Object used to perform update manipulations on the MetaData

Summary

Public Methods
abstract String getCurrentVersion()
Return the current version of the MD connected to by the IServer.
abstract String getLogPath()
Return the path where a log will be stored upon update
abstract boolean needMDXUpdate(boolean quickCheck)
Check to see if the current MD needs to update its MDX components
abstract boolean needUpdate()
Returns whether the current MD needs to be updated to work optimally with the current version of the MSTR product.
abstract void setLogPath(String logPath)
Set the path where a log of the update can be stored
abstract String update(int command, int fg)
Send a custom update command
abstract String update(int command)
Send a custom update command
abstract void updateDocDefns()
This method is deprecated. use update(int) instead
abstract void updateHistoryListSchedules()
Update the MD History List schedules
abstract void updateIncrementalPrivileges(int privTypes)
Update privileges as specified
abstract void updateMD()
Updates the entire MD to a version that will work with the current version of the MSTR product.
abstract void updateProject()
Updates the project currently associated with the IServer session.
abstract void updateSecurityModel()
Update the MD security model
abstract void updateTranslations()
Update the translations stored in MD

Public Methods

public abstract String getCurrentVersion ()

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

public abstract String getLogPath ()

Return the path where a log will be stored upon update

Returns
  • String containing path information

public abstract boolean needMDXUpdate (boolean quickCheck)

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
WebObjectsException

public abstract boolean needUpdate ()

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

public abstract void setLogPath (String logPath)

Set the path where a log of the update can be stored

Parameters
logPath String containing the path information

public abstract String update (int command, int fg)

Send a custom update command

Parameters
command int from EnumDSSXMLMDUpdateCommands specifiying an IServer flag
Returns
  • String containing results of the command
Throws
WebObjectsException

public abstract String update (int command)

Send a custom update command

Parameters
command int from EnumDSSXMLMDUpdateCommands specifiying which command to send to the IServer
Returns
  • String containing results of the command
Throws
WebObjectsException

public abstract void updateDocDefns ()

This method is deprecated.
use update(int) instead

Update the MD document definitions

Throws
WebObjectsException
WebObjectsException

public abstract void updateHistoryListSchedules ()

Update the MD History List schedules

Throws
WebObjectsException

public abstract void updateIncrementalPrivileges (int privTypes)

Update privileges as specified

Parameters
privTypes int binary OR of EnumDSSXMLPrivilegeUpdateTypes
Throws
WebObjectsException

public abstract void updateMD ()

Updates the entire MD to a version that will work with the current version of the MSTR product.

Throws
WebObjectsException

public abstract void updateProject ()

Updates the project currently associated with the IServer session. Exception is thrown if this method is called with a configuration session

Throws
WebObjectsException

public abstract void updateSecurityModel ()

Update the MD security model

Throws
WebObjectsException

public abstract void updateTranslations ()

Update the translations stored in MD

Throws
WebObjectsException