public interface

WebObjectSource

com.microstrategy.web.objects.WebObjectSource

Class Overview

The WebObjectSource object is used to execute object-related operations and instantiate objects such as WebObjectInfo and WebSearch. In addition, many of the other API objects take WebObjectInfo objects as arguments, and this is the only method which can create instances of WebObjectInfo.

Note that many WebObjectInfo objects obtained from the methods on this interfaces are read-only. But there are several types of objects are editable. Among the editable objects, some of them are editable and can be saved back to metadata: WebMonitor, WebServerDef, WebMDSecurityFilter, WebSecurityRole, WebShortcut and WebUser objects; some of them are editable but can not be saved back to metadata: WebFilter and WebSearch objects. However, the WebAccessControlList is editable for any type of object.

Also note that in order to modify an object which exists in metadata, the object must be populated, either by specifying the populate flag when obtaining an object as true, or by calling populate() on it. However, if an object which is not read-only is obtained from the getNewObject(int) call(monitor, serverdef, or user), then it can also be modified without population.

This list of objects is of the 8.0 release, which can be modified may change from release to release.

All objects, including both read-only and read-write objects, are able to be copied via the copy method. All objects also may be renamed or moved -- see the "save" methods below for details on how to move or rename an object.

Summary

Public Methods
abstract void changeObjectID(String objectId, int type, String newId)
Change DSS ID of the given object.
abstract void changeObjectID(WebObjectInfo object, String newId)
Change DSS ID of the given object.
abstract WebObjectInfo copy(WebObjectInfo sourceObject, String targetObjectName)
Creates a copy of the object passed (sourceObject).
abstract WebObjectInfo copy(WebObjectInfo sourceObject, String targetObjectName, WebFolder location)
Creates a copy of the object passed (sourceObject).
abstract WebObjectInfo copy(WebObjectInfo sourceObject, WebFolder location)
Creates a copy of the object passed (sourceObject).
abstract String createFolder(String folderName, String parentFolderID)
Creates a folder in metadata with the given name and parent folder ID.
abstract String createFolder(String folderName, String parentFolderID, String folderDesc)
Creates a folder in metadata with the given name, parent folder ID, and description.
abstract String createLocale(String name, int localeID, int localeFlag, String folderID, int objectFlag)
This manipulation allows the caller to create a locale object.
abstract void deleteObject(String objectID, int objectType)
Deletes the object with the given DSS ID and type from the metadata.
abstract void deleteObject(WebObjectInfo object)
Deletes the given object from the metadata.
abstract String deleteTranslation(String objectID, int objectType, String key, int localeID)
This manipulation allows user to delete one translation at any locale for one unembedded object.
abstract void destroyCrawl(String projectID)
To destroy crawl on project
abstract void enableSearch(String projectID, boolean enable)
To enable/disable project
abstract WebServerDef getActiveServerDef()
Returns the WebServerDef object corresponding to the Server Definition object currently being used by the Intelligence Server.
abstract WebFolder getAllAvailableLocales()
Return all the available locales supported by the IServer
abstract WebFolder getAllStyles()
Returns a populated WebFolder which contains both the system styles and the user styles.
abstract void getAndSetExternalSourceSessionInfo(int flags, String sourceID, int sourceType, String userName, String localeDateNumber, Map<String, String> tokenInfo)
abstract WebFolder getAvailableDBRoles()
Retrieves a list of the available db roles.
abstract int getBlockBegin()
Returns the current setting for the blockBegin parameter which is used upon retrieving folder definitions from the Intelligence Server.
abstract int getBlockCount()
Returns the current setting for the blockCount parameter which is used upon retrieving folder definitions from the Intelligence Server.
abstract List<WebDSN> getConfiguredDSNs()
Returns a list of DSNs configured on the I-Server machine.
abstract WebConnectionMapSource getConnectionMapSource()
Obtain WebConnectionMapSource object to find and create WebConnectionMap objects
abstract WebElementSource getElementSource()
abstract int getFlags()
Returns the current setting of the flags which will determine what data will be obtained when retrieving object definitions from the Intelligence Server.
abstract String getFolderID(int folderName)
Returns the folder ID of one of the special folders in metadata.
abstract ProjectIndexMetadata getIndexMetadata(String projectID)
To get the index metedata
abstract WebObjectInfo getLeanObject(String objectID, int objectType)
To get the device/transmitter object
abstract int getLevel()
Returns the current level parameter, which will be used when obtaining folder contents.
abstract WebMDXCubeSource getMDXCubeSource()
This method will return the WebMDXCubeSource interface, which can be used to initiate cube browsing and cube object browsing requests.
abstract String getMessageID()
Returns the messageID for get object command.
abstract WebChangeJournalSearch getNewChangeJournalSearch()
Returns a WebChangeJournalSearch object, which can be used to execute a change journal search.
abstract WebFilter getNewFilter()
Returns a WebFilter object.
abstract WebObjectInfo getNewObject(int objectType, int subType)
Returns a new object of the type and subtype passed.
abstract WebObjectInfo getNewObject(int objectType, String name)
Returns a new object of the type passed.
abstract WebObjectInfo getNewObject(int objectType)
Returns a new object of the type passed.
abstract WebObjectInfo getNewObject(int objectType, int subType, String name)
Returns a new object of the type and subtype passed.
abstract WebSearch getNewSearchObject()
Returns a WebSearch object, which can be used to execute a search.
abstract int getNumberOfDependencies(String objectID, int objectType, int objectSubType)
This manipulation returns the dependencies for the current object.
abstract WebObjectInfo getObject(String objectID, int objectType, boolean populate)
Returns a WebObjectInfo object representing an object which resides in metadata.
abstract WebObjectInfo getObject(String objectID, int objectType, int objectSubType, boolean populate)
Returns a WebObjectInfo object representing an object which resides in metadata.
abstract WebObjectInfo getObject(String objectID, int objectType, int objectSubType)
Returns a WebObjectInfo object representing an object which resides in metadata.
abstract WebObjectInfo getObject(String objectID, int objectType)
Returns a WebObjectInfo object representing an object which resides in metadata.
abstract WebObjectInfo getObjectByPath(String fullPath, int objectType)
Returns a WebObjectInfo object representing an object which resides in metadata by folderPath.
abstract WebObjectInfo getObjectByPath(String fullPath, int objectType, int objectSubType)
Returns a WebObjectInfo object representing an object which resides in metadata by folderPath.
abstract WebObjectInfo getObjectFromState(String state)
This method will take the given object state and return the WebObjectInfo object that the state describes.
abstract WebParsedMetric getParsedMetric(String metricID)
Get a parsed metric object with the specified metric ID.
abstract int getPropertyFlags()
Retrieve the current property flags
abstract String getQuickSearchStatus()
abstract WebFolder getRoot()
Returns a populated WebFolder which contains the contents of the root folder.
abstract SearchEngineProperties getSearchEngineProperties()
To get the search engine properties
abstract List<WebSearchSuggestion> getSearchSuggestions(String searchKey, int localeId)
abstract Map<Integer, String> getServerSettings()
abstract WebSourceManipulator getSourceManipulator()
abstract WebFunctionFolders getSystemFunctions(int functionFlags)
Retrieves the list of system functions based on the flags.
abstract WebFolder getSystemStyles()
Returns a populated WebFolder which contains the system styles.
abstract TransactionElement getTransactionElement(String transactionReportID)
abstract WebFolder getTransformationRoles()
This method will return a WebFolder containing the transformation roles that are available in the project.
abstract WebUserServicesSource getUserServicesSource()
This method returns the WebUserServicesSource interface, which contains user-management related operations.
abstract WebFolder getUserStyles()
Returns a populated WebFolder which contains the user styles.
abstract boolean isChangeJournalEnabled()
To get if change journal enabled if true, it is enabled, else disabled.
abstract boolean isSearchEnabled(String projectID)
To check if search on project
abstract boolean isSearchEngineStarted()
To check if search engine has been started
abstract WebLocaleTranslation[] listTranslations(WebObjectInfo objectInfo, String[] keyList, int[] localeIDList, int qualities)
This manipulation allows user to list any translations at any locales for any keys for multiple objects and their embedded objects.
abstract void moveObject(String objectID, int objectType, String newName)
Move an existing object in the metadata.
abstract WebElements newElements(WebAttribute attribute)
Creates an empty element collection associated with the specified attribute
abstract WebExpression newExpression()
Creates new expression object
abstract WebPrompts newPrompts(String messageId, int objectType)
abstract void pauseCrawl(String projectID)
To pause crawl on project
abstract void propagateACLToChildren(WebObjectInfo objectToSave, int flag)
abstract void purgeChangeJournal(String timestamp, String comment, int allProjects)
To purge specific time stamp change journal
abstract void resumeCrawl(String projectID)
To resume crawl on project
abstract WebObjectInfo save(WebObjectInfo objectToSave)
Saves the object passed, to metadata.
abstract WebObjectInfo save(WebObjectInfo objectToSave, String name)
Saves the object passed, to metadata.
abstract WebObjectInfo save(WebObjectInfo objectToSave, String name, WebFolder folder)
Saves the object passed, to the new location (specified by folder) in metadata.
abstract WebObjectInfo save(WebObjectInfo objectToSave, WebFolder folder)
Saves the object passed, to the new location (specified by folder) in metadata.
abstract WebObjectInfo saveAs(WebObjectInfo objectToSave, String name, WebFolder folder, boolean overwrite)
abstract void saveObjects(HashMap<WebObjectInfoWebFolder> objectInfos)
Bulk Save the object to metadata.
abstract void setBlockBegin(int blockBegin)
Sets the blockBegin parameter which is used upon retrieving folder definitions from the Intelligence Server.
abstract void setBlockCount(int blockCount)
Sets the blockCount parameter which is used upon retrieving folder definitions from the Intelligence Server.
abstract void setChangeJournalStatus(boolean enabled, String comment, int allProjects)
To set change journal to enabled/disabled
abstract void setFlags(int flags)
Sets the current setting of the flags which will determine what data will be obtained when retrieving object definitions from the Intelligence Server.
abstract void setLevel(int level)
Sets the current level parameter, which will be used when obtaining folder contents.
abstract void setMessageID(String _messageID)
Set the messageID for get object command.
abstract void setPropertyFlags(int flags)
Set the current property flags
abstract void startCrawl(String projectID)
To start crawl on project
abstract void startIncrementalCrawl(String projectID)
To start incremental crawl on project
abstract void startSearchEngine()
To start search engine
abstract void stopIncrementalCrawl(String projectID)
To stop incremental crawl on project
abstract void stopSearchEngine()
To stop search engine
abstract String updateTranslation(String objectID, int objectType, String key, int localeID, String name)
This manipulation allows user to add, update one translation at any locale for one unembedded object.
abstract String updateTranslations(WebObjectInfo objectInfo, WebLocaleTranslation[] toUpdateList, WebLocaleTranslation[] toDeleteList)
This manipulation allows user to add, update, and delete any translations at any locale for one object.
abstract void validateObjectName(String name)
This method will ensure that the given object name is a valid name for a first class object.

Public Methods

public abstract void changeObjectID (String objectId, int type, String newId)

Change DSS ID of the given object.

Parameters
newId The new DSS ID.

public abstract void changeObjectID (WebObjectInfo object, String newId)

Change DSS ID of the given object.

Parameters
object The object to be changed.
newId The new DSS ID.

public abstract WebObjectInfo copy (WebObjectInfo sourceObject, String targetObjectName)

Creates a copy of the object passed (sourceObject). The new object is created in the same location as the source object. The object to be copied should thus be an existing object in the metadata. Further, if the object passed is an editable object (e.g. WebMonitor,WebPerformanceMonitor, WebServerDef), the changes done to the object after loading it from metadata are saved in the copied object too. Changes done to non-editable objects cannot be saved/copied and attempt to copy such objects will end in error. This will work on non-editable objects whose definition has not been changed.

Parameters
sourceObject The object to be copied.
targetObjectName The name of the copied object.
Returns
  • WebObjectInfo The copied object.
Throws
WebObjectsException thrown if an error is encountered by IServer.

public abstract WebObjectInfo copy (WebObjectInfo sourceObject, String targetObjectName, WebFolder location)

Creates a copy of the object passed (sourceObject). The new object, will be named by targetObjectName and will be created in the location specified by location. If the object passed is an editable object (e.g. WebMonitor,WebPerformanceMonitor, WebServerDef), that already exists in the metadata, the changes done to the object after loading from metadata are saved in the copied object too. If the editable object passed however, is a new object that does not exist in the metadata, a new object will be created in the metadata at the location specified. For non-editable objects, copy can be created only if the object is an existing object in the metadata and no changes have been done to object since loading it from the metadata. This will work on non-editable objects whose definition has not been changed.

Parameters
sourceObject The object to be copied.
targetObjectName The name of the copied object.
location The target folder for copying the object.
Returns
  • WebObjectInfo The copied object.
Throws
WebObjectsException thrown if an error is encountered by IServer.

public abstract WebObjectInfo copy (WebObjectInfo sourceObject, WebFolder location)

Creates a copy of the object passed (sourceObject). The new object will be created in the location specified by location. If the object passed is an editable object (e.g. WebMonitor,WebPerformanceMonitor, WebServerDef), that already exists in the metadata, the changes done to the object after loading from metadata are saved in the copied object too. The name of the copied object will be the same as the sourceObject. If the editable object passed however, is a new object that does not exist in the metadata, a new object will be created in the metadata at the location specified. For non-editable objects, copy can be created only if the object is an existing object in the metadata and no changes have been done to object since loading it from the metadata.

Parameters
sourceObject The object to be copied.
location The target folder for copying the object.
Returns
  • WebObjectInfo The copied object.
Throws
WebObjectsException thrown if an error is encountered by IServer.

public abstract String createFolder (String folderName, String parentFolderID)

Creates a folder in metadata with the given name and parent folder ID.

Parameters
folderName The name to give to the folder.
parentFolderID The DSS ID of the parent folder.
Returns
  • The DSS ID of the newly created folder.
Throws
WebObjectsException Thrown if the folder could not be created.

public abstract String createFolder (String folderName, String parentFolderID, String folderDesc)

Creates a folder in metadata with the given name, parent folder ID, and description.

Parameters
folderName The name to give to the folder.
parentFolderID The DSS ID of the parent folder.
folderDesc The description to give to the newly created folder.
Returns
  • The DSS ID of the newly created folder.
Throws
WebObjectsException Thrown if the folder could not be created.

public abstract String createLocale (String name, int localeID, int localeFlag, String folderID, int objectFlag)

This manipulation allows the caller to create a locale object.

Parameters
name the name of new locale
localeID locale id
localeFlag It has the effect of adding the new locale to the list of supported metadata and / or data locales in the project. If it is not needed, you can set it to 0;
folderID folder id where the locale is stored
objectFlag EnumDSSXMLObjectFlags, the default value is DssXmlObjectSaveOverwrite(16777216)
Returns
  • the id of newly created locale

public abstract void deleteObject (String objectID, int objectType)

Deletes the object with the given DSS ID and type from the metadata.

Parameters
objectID The DSS ID of the object to be deleted.
objectType The type of the object to be deleted. This value comes from EnumDSSXMLObjectTypes.
Throws
WebObjectsException Thrown if an error occurs upon attempting to delete the object.

public abstract void deleteObject (WebObjectInfo object)

Deletes the given object from the metadata.

Parameters
object The object to be deleted.
Throws
WebObjectsException Thrown if an error occurs upon attempting to delete the object.

public abstract String deleteTranslation (String objectID, int objectType, String key, int localeID)

This manipulation allows user to delete one translation at any locale for one unembedded object.

Parameters
objectID object id
objectType object type
key translation key
localeID locale id
Returns
  • the number of deleted translations.
Throws
WebObjectsException
IllegalArgumentException
WebObjectsException

public abstract void destroyCrawl (String projectID)

To destroy crawl on project

public abstract void enableSearch (String projectID, boolean enable)

To enable/disable project

public abstract WebServerDef getActiveServerDef ()

Returns the WebServerDef object corresponding to the Server Definition object currently being used by the Intelligence Server. This object will already be populated when it is returned.

Returns
Throws
WebObjectsException Thrown if an error occurs.

public abstract WebFolder getAllAvailableLocales ()

Return all the available locales supported by the IServer

Returns
Throws
WebObjectsException
WebObjectsException

public abstract WebFolder getAllStyles ()

Returns a populated WebFolder which contains both the system styles and the user styles.

Returns
  • A populated WebFolder object which contains both the system styles and the user styles.
Throws
WebObjectsException Signals an error condition while attempting to obtain the folder XML.

public abstract void getAndSetExternalSourceSessionInfo (int flags, String sourceID, int sourceType, String userName, String localeDateNumber, Map<String, String> tokenInfo)

public abstract WebFolder getAvailableDBRoles ()

Retrieves a list of the available db roles. One possible db role from this list should be

Returns

public abstract int getBlockBegin ()

Returns the current setting for the blockBegin parameter which is used upon retrieving folder definitions from the Intelligence Server. This parameter, along with blockCount, are used for incremental fetch. This will be propagated to all child objects.

Returns
  • The current blockBegin setting.

public abstract int getBlockCount ()

Returns the current setting for the blockCount parameter which is used upon retrieving folder definitions from the Intelligence Server. This parameter, along with blockBegin, are used for incremental fetch. This will be propagated to all child objects.

Returns
  • The current blockCount setting.

public abstract List<WebDSN> getConfiguredDSNs ()

Returns a list of DSNs configured on the I-Server machine.

Returns
Throws
WebObjectsException
WebObjectsException

public abstract WebConnectionMapSource getConnectionMapSource ()

Obtain WebConnectionMapSource object to find and create WebConnectionMap objects

Returns

public abstract WebElementSource getElementSource ()

public abstract int getFlags ()

Returns the current setting of the flags which will determine what data will be obtained when retrieving object definitions from the Intelligence Server. This value will come from the bitwise or (|) of values from EnumDSSXMLObjectFlags.

Returns
  • The current object flag value.
See Also

public abstract String getFolderID (int folderName)

Returns the folder ID of one of the special folders in metadata. The folder which will have information returned for it comes from EnumDSSXMLFolderNames.

Parameters
folderName A value from EnumDSSXMLFolderNames.
Returns
  • The DSS ID corresponding to the given folder name. If the special folder does not exist in the metadata, the returned ID will be null.
Throws
WebObjectsException Thrown if an error occurs in obtaining the ID.

public abstract ProjectIndexMetadata getIndexMetadata (String projectID)

To get the index metedata

Returns
  • an instance of ProjectIndexMetadata.

public abstract WebObjectInfo getLeanObject (String objectID, int objectType)

To get the device/transmitter object

Returns
  • device/transmitter object

public abstract int getLevel ()

Returns the current level parameter, which will be used when obtaining folder contents.

Returns
  • The current level setting.
See Also

public abstract WebMDXCubeSource getMDXCubeSource ()

This method will return the WebMDXCubeSource interface, which can be used to initiate cube browsing and cube object browsing requests.

Returns

public abstract String getMessageID ()

Returns the messageID for get object command.

Returns
  • the messageID for get object command.

public abstract WebChangeJournalSearch getNewChangeJournalSearch ()

Returns a WebChangeJournalSearch object, which can be used to execute a change journal search.

Returns

public abstract WebFilter getNewFilter ()

Returns a WebFilter object.

Returns

public abstract WebObjectInfo getNewObject (int objectType, int subType)

Returns a new object of the type and subtype passed. Only monitor, search, ServerDef, and filter objects are supported.

Parameters
objectType object type.
subType object subtype.
Returns
  • the new object.

public abstract WebObjectInfo getNewObject (int objectType, String name)

Returns a new object of the type passed. The object returned will have the name passed. Only search, ServerDef, and filter objects are supported. New monitor objects can be obtained too, but they require a subType. Hence use getNewObject(int, int) or getNewObject(int, int, String) for new new monitor objects.

Parameters
objectType the object type.
name the object name for the new object.
Returns
  • WebObjectInfo the new object.

public abstract WebObjectInfo getNewObject (int objectType)

Returns a new object of the type passed. Only search, serverdef, user, and filter objects are supported. New monitor objects can be obtained too, but they require a subType. Hence use getNewObject(int, int) or getNewObject(int, int, String) for new new monitor objects.

Parameters
objectType object type.
Returns
  • the new object.

public abstract WebObjectInfo getNewObject (int objectType, int subType, String name)

Returns a new object of the type and subtype passed. The object returned will have the name passed. Only monitor, search, ServerDef, and filter objects are supported.

Parameters
objectType the object type.
subType the object sub type.
name the object name for the new object.
Returns
  • WebObjectInfo the new object.

public abstract WebSearch getNewSearchObject ()

Returns a WebSearch object, which can be used to execute a search.

Returns

public abstract int getNumberOfDependencies (String objectID, int objectType, int objectSubType)

This manipulation returns the dependencies for the current object.

Parameters
objectID The unique id of the object.
objectType The type of the object, from EnumDSSXMLObjectTypes.
objectSubType The type of the object, from EnumDSSXMLObjectSubTypes.
Returns
  • the number of dependencies.
Throws
WebObjectsException
IllegalArgumentException
WebObjectsException

public abstract WebObjectInfo getObject (String objectID, int objectType, boolean populate)

Returns a WebObjectInfo object representing an object which resides in metadata. This object may or may not be populated with information about this object from the Intelligence Server, depending upon the populate parameter.

Parameters
objectID The DSS ID of the object.
objectType The type of the object. This value comes from EnumDSSXMLObjectTypes.
populate If this is true, then the WebObjectInfo object will populate itself with the object's definition from the Intelligence Server.
Returns
  • A WebObjectInfo object corresponding to the given DSS ID and type. the object definition of this object from the Intelligence Server. If this is false, then the object will not be populated.
Throws
WebObjectsException Thrown if the object could not be created or populated.
IllegalArgumentException Thrown if the object ID is invalid.

public abstract WebObjectInfo getObject (String objectID, int objectType, int objectSubType, boolean populate)

Returns a WebObjectInfo object representing an object which resides in metadata. This object may or may not be populated with information about this object from the Intelligence Server, depending upon the populate parameter.

Parameters
objectID The DSS ID of the object.
objectType The type of the object. This value comes from EnumDSSXMLObjectTypes.
objectSubType The subtype of the object. This value comes from EnumDSSXMLObjectTypes.
populate If this is true, then the WebObjectInfo object will populate itself with the object's definition from the Intelligence Server.
Returns
  • A WebObjectInfo object corresponding to the given DSS ID and type.
Throws
WebObjectsException Thrown if the object could not be created.
IllegalArgumentException Thrown if the object ID is invalid.

public abstract WebObjectInfo getObject (String objectID, int objectType, int objectSubType)

Returns a WebObjectInfo object representing an object which resides in metadata. This object will NOT be populated with the object's definition from the Intelligence Server.

Parameters
objectID The DSS ID of the object.
objectType The type of the object. This value comes from EnumDSSXMLObjectTypes.
objectSubType The subtype of the object. This value comes from EnumDSSXMLObjectTypes.
Returns
  • A WebObjectInfo object corresponding to the given DSS ID and type.
Throws
WebObjectsException Thrown if the object could not be created.
IllegalArgumentException Thrown if the object ID is invalid.

public abstract WebObjectInfo getObject (String objectID, int objectType)

Returns a WebObjectInfo object representing an object which resides in metadata. This object will NOT be populated with the object's definition from the Intelligence Server.

Parameters
objectID The DSS ID of the object.
objectType The type of the object. This value comes from EnumDSSXMLObjectTypes.
Returns
  • A WebObjectInfo object corresponding to the given DSS ID and type.
Throws
WebObjectsException Thrown if the object could not be created.
IllegalArgumentException Thrown if the object ID is invalid.

public abstract WebObjectInfo getObjectByPath (String fullPath, int objectType)

Returns a WebObjectInfo object representing an object which resides in metadata by folderPath.

Parameters
fullPath The full path of the object. If the object is shortcut, it includes the target name of the shortcut.
objectType The type of the object. This value comes from EnumDSSXMLObjectTypes.
Returns
  • A WebObjectInfo object corresponding to the given DSS ID and type.
Throws
WebObjectsException Thrown if the object could not be created.
IllegalArgumentException Thrown if the object ID is invalid.

public abstract WebObjectInfo getObjectByPath (String fullPath, int objectType, int objectSubType)

Returns a WebObjectInfo object representing an object which resides in metadata by folderPath.

Parameters
fullPath The full path of the object. If the object is shortcut, it includes the target name of the shortcut.
objectType The type of the object. This value comes from EnumDSSXMLObjectTypes.
objectSubType The subtype of the object. This value comes from EnumDSSXMLObjectSubTypes.
Returns
  • A WebObjectInfo object corresponding to the given DSS ID and type.
Throws
WebObjectsException Thrown if the object could not be created.
IllegalArgumentException Thrown if the object ID is invalid.

public abstract WebObjectInfo getObjectFromState (String state)

This method will take the given object state and return the WebObjectInfo object that the state describes. This is used to restore the state of a WebObjectInfo object.

Parameters
state The object state that describes the object.
Returns
Throws
IllegalArgumentException Thrown if the state passed is invalid.
WebObjectsException

public abstract WebParsedMetric getParsedMetric (String metricID)

Get a parsed metric object with the specified metric ID. The metricID argument could be null when trying to create a new metric.

Returns
  • a parsed metric object

public abstract int getPropertyFlags ()

Retrieve the current property flags

Returns

public abstract String getQuickSearchStatus ()

public abstract WebFolder getRoot ()

Returns a populated WebFolder which contains the contents of the root folder.

Returns
  • A populated WebFolder object, corresponding to the root folder.
Throws
WebObjectsException Signals an error condition while attempting to obtain the folder XML.

public abstract SearchEngineProperties getSearchEngineProperties ()

To get the search engine properties

Returns
  • an instance of SearchEngineProperties.

public abstract List<WebSearchSuggestion> getSearchSuggestions (String searchKey, int localeId)

public abstract Map<Integer, String> getServerSettings ()

public abstract WebSourceManipulator getSourceManipulator ()

public abstract WebFunctionFolders getSystemFunctions (int functionFlags)

Retrieves the list of system functions based on the flags.

Parameters
functionFlags - values from EnumDSSXMLFunctionsFlags
Returns
  • WebFunctionFolders object
Throws
WebObjectsException thrown if there is any error.

public abstract WebFolder getSystemStyles ()

Returns a populated WebFolder which contains the system styles.

Returns
  • A populated WebFolder object which contains the system styles.
Throws
WebObjectsException Signals an error condition while attempting to obtain the folder XML.

public abstract TransactionElement getTransactionElement (String transactionReportID)

Returns
  • the transactionElement with ID equals transactionReportID
Throws
WebObjectsException
WebObjectsException

public abstract WebFolder getTransformationRoles ()

This method will return a WebFolder containing the transformation roles that are available in the project. Transformation roles are used in dealing with shortcut metrics.

Returns
  • A WebFolder object containing the transformation roles in the project.
Throws
WebObjectsException Thrown if an error occurs in obtaining transformation roles.

public abstract WebUserServicesSource getUserServicesSource ()

This method returns the WebUserServicesSource interface, which contains user-management related operations. The WebUserServicesSource interface exists primarily for organizational purposes.

Returns

public abstract WebFolder getUserStyles ()

Returns a populated WebFolder which contains the user styles.

Returns
  • A populated WebFolder object which contains the user styles.
Throws
WebObjectsException Signals an error condition while attempting to obtain the folder XML.

public abstract boolean isChangeJournalEnabled ()

To get if change journal enabled if true, it is enabled, else disabled.

public abstract boolean isSearchEnabled (String projectID)

To check if search on project

Returns
  • true if search is enabled; false if disabled.

public abstract boolean isSearchEngineStarted ()

To check if search engine has been started

Returns
  • true if it has started, false if it has not

public abstract WebLocaleTranslation[] listTranslations (WebObjectInfo objectInfo, String[] keyList, int[] localeIDList, int qualities)

This manipulation allows user to list any translations at any locales for any keys for multiple objects and their embedded objects.

Parameters
objectInfo only translations under this object will be listed. If this object is embedded, it should contains its container’s imformation(container id and container type).
keyList Translation will be in the result only if its key is in this array. If is empty, will have the effect of listing translations for all keys.
localeIDList Translation will be in the result only if its locale id is in this array. If is empty, will have the effect of listing translations at all locales.
qualities have the effect of filtering multilingual strings during iteration:
Returns
  • the WebLocaleTranslation Array at any locales for any keys for one object.
Throws
WebObjectsException
IllegalArgumentException
WebObjectsException

public abstract void moveObject (String objectID, int objectType, String newName)

Move an existing object in the metadata.

Parameters
objectID The DSSID of the object to move.
objectType The type of the object to move.
newName The name of the moved object.
Throws
WebObjectsException Thrown if an error occurs upon attempting to move the object

public abstract WebElements newElements (WebAttribute attribute)

Creates an empty element collection associated with the specified attribute

Parameters
attribute attribute.

public abstract WebExpression newExpression ()

Creates new expression object

public abstract WebPrompts newPrompts (String messageId, int objectType)

public abstract void pauseCrawl (String projectID)

To pause crawl on project

public abstract void propagateACLToChildren (WebObjectInfo objectToSave, int flag)

public abstract void purgeChangeJournal (String timestamp, String comment, int allProjects)

To purge specific time stamp change journal

public abstract void resumeCrawl (String projectID)

To resume crawl on project

public abstract WebObjectInfo save (WebObjectInfo objectToSave)

Saves the object passed, to metadata. The object passed should be an already existing object in the metadata. For editable object, using this method will ensure that the changes done to the object after loading it from metadata will be saved back. For non-editable objects, if its WebAccessControlList has been changed, those changes will be saved.

Parameters
objectToSave An object to save.
Returns
  • WebObjectInfo The saved object.
Throws
WebObjectsException thrown if an error is encountered by IServer.

public abstract WebObjectInfo save (WebObjectInfo objectToSave, String name)

Saves the object passed, to metadata. The object passed should be an already existing object in the metadata. This method will rename the object passed in to the new name specified by the name. For editable object, using this method will ensure that the changes done to the object after loading it from metadata will be saved back. For non-editable objects, if its WebAccessControlList has been changed, those changes will be saved.

Parameters
objectToSave An object to save.
name New name for the object passed.
Returns
  • WebObjectInfo The saved object.
Throws
WebObjectsException thrown if an error is encountered by IServer.

public abstract WebObjectInfo save (WebObjectInfo objectToSave, String name, WebFolder folder)

Saves the object passed, to the new location (specified by folder) in metadata. If the object passed is an already existing object in the metadata, this call will effectively move the object to the new location specified by folder. This method will rename the object passed in to the new name specified by the name. For editable object, using this method will ensure that the changes done to the object after loading it from metadata will be saved back. For non-editable objects, if its WebAccessControlList has been changed, those changes will be saved. If a non-existing editable object is passed (one created through getNewObject(int)), this method will create a new corresponding object in metadata at the location specified and return it.

Parameters
objectToSave the object to save.
name Name to be set to the saved object.
folder The target folder for saving the object.
Returns
  • WebObjectInfo The saved object.
Throws
WebObjectsException thrown if an error is encountered by IServer.

public abstract WebObjectInfo save (WebObjectInfo objectToSave, WebFolder folder)

Saves the object passed, to the new location (specified by folder) in metadata. If the object passed is an already existing object in the metadata, this call will effectively move the object to the new location specified by folder. For editable object, using this method will ensure that the changes done to the object after loading it from metadata will be saved back. For non-editable objects, if its WebAccessControlList has been changed, those changes will be saved. If a non-existing editable object is passed (one created through getNewObject(int)), this method will create a new corresponding object in metadata at the location specified and return it.

Parameters
objectToSave the object to save.
folder The target folder for saving the object.
Returns
  • WebObjectInfo The saved object.
Throws
WebObjectsException thrown if an error is encountered by IServer.

public abstract WebObjectInfo saveAs (WebObjectInfo objectToSave, String name, WebFolder folder, boolean overwrite)

public abstract void saveObjects (HashMap<WebObjectInfoWebFolder> objectInfos)

Bulk Save the object to metadata. The object passed should be an already existing object in the metadata. For editable object, using this method will ensure that the changes done to the object after loading it from metadata will be saved back. For non-editable objects, if its WebAccessControlList has been changed, those changes will be saved.

Returns
  • .
Throws
WebObjectsException thrown if an error is encountered by IServer.

public abstract void setBlockBegin (int blockBegin)

Sets the blockBegin parameter which is used upon retrieving folder definitions from the Intelligence Server. This parameter, along with blockCount, are used for incremental fetch. This will be propagated to all child objects.

Parameters
blockBegin The new blockBegin setting to use for folder retrieval.
See Also

public abstract void setBlockCount (int blockCount)

Sets the blockCount parameter which is used upon retrieving folder definitions from the Intelligence Server. This parameter, along with blockBegin, are used for incremental fetch. This will be propagated to all child objects.

Parameters
blockCount The new blockCount setting to use for folder retrieval.
See Also

public abstract void setChangeJournalStatus (boolean enabled, String comment, int allProjects)

To set change journal to enabled/disabled

public abstract void setFlags (int flags)

Sets the current setting of the flags which will determine what data will be obtained when retrieving object definitions from the Intelligence Server. This value should come from the bitwise or (|) of values from EnumDSSXMLObjectFlags.

Parameters
flags The current object flag value.
See Also

public abstract void setLevel (int level)

Sets the current level parameter, which will be used when obtaining folder contents.

Parameters
level The new level setting.
See Also

public abstract void setMessageID (String _messageID)

Set the messageID for get object command.

Parameters
_messageID the messageID for get object command

public abstract void setPropertyFlags (int flags)

Set the current property flags

Parameters
flags int binary OR of EnumDSSXMLPropertyXmlFlags

public abstract void startCrawl (String projectID)

To start crawl on project

public abstract void startIncrementalCrawl (String projectID)

To start incremental crawl on project

public abstract void startSearchEngine ()

To start search engine

public abstract void stopIncrementalCrawl (String projectID)

To stop incremental crawl on project

public abstract void stopSearchEngine ()

To stop search engine

public abstract String updateTranslation (String objectID, int objectType, String key, int localeID, String name)

This manipulation allows user to add, update one translation at any locale for one unembedded object.

Parameters
objectID object id
objectType object type
key translation key
localeID locale id
name translation name
Returns
  • the number of added/updated translations.
Throws
WebObjectsException
IllegalArgumentException
WebObjectsException

public abstract String updateTranslations (WebObjectInfo objectInfo, WebLocaleTranslation[] toUpdateList, WebLocaleTranslation[] toDeleteList)

This manipulation allows user to add, update, and delete any translations at any locale for one object.

Parameters
objectInfo object
Returns
  • the number of deleted translations.
Throws
WebObjectsException
IllegalArgumentException
WebObjectsException

public abstract void validateObjectName (String name)

This method will ensure that the given object name is a valid name for a first class object. If it is not a valid name, an exception will be thrown.

Parameters
name The name to check for validity.
Throws
WebObjectsException Thrown if the name is not valid.