WebObjectSource

Certify or decertify object in the metadata.

Change DSS ID of the given object.

Change DSS ID of the given object.

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.

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.

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.

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

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

This manipulation allows the caller to create a locale object.

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

Deletes the given object from the metadata.

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

To destroy crawl on project

To enable/disable project

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.

Return all the available locales supported by the IServer

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

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

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 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 a list of DSNs configured on the I-Server machine.

Obtain WebConnectionMapSource object to find and create WebConnectionMap objects

This method get an cube's security filter for certain user. Explain for backend implement of cube level's security filter: there is no first class object for cube security filter which actually is combined to user level's security filter in MD, the cube security filter expression is pruned form user level's filter by backend.@return

This method get the cube's security filters. Explain for backend implement of cube level's security filter: there is no first class object for cube security filter which actually is combined to user level's security filter in MD, the cube security filter expression is pruned form user level's filter by backend. Currently,backend returns cube's security filters through checking userIds in cube's ACL when only provided cubeId.@return

This method get the cube's security filters. if only provide cubeId, the method will return cube's all security filters for provided cube. if provide cubeId and userId, the method will return an cube's security filter for provided cube related to provided user. Explain for backend implement of cube level's security filter: there is no first class object for cube security filter which actually is combined to user level's security filter in MD, the cube security filter expression is pruned form user level's filter by backend. Currently,backend returns cube's security filters through checking userIds in cube's ACL when only provided cubeId.@return

Returns a WebEmailNotification object, which can be used to send email notification

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 folder ID of one of the special folders in metadata. The folder which will have information returned for it comes from EnumDSSXMLFolderNames.

To get the index metedata

This method is used for getting the VLDB property inherited value of an instance. The internal logic can be seen in the doc "VLDB Overall design"

To get the device/transmitter object

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

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

Returns the messageID for get object command.

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

Returns a WebFilter object.

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.

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

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.

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.

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

This manipulation returns the dependencies for the current object.

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.

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.

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.

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.

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

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

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.

This method is used for getting the VLDB property inherited value of an object. The internal logic can be seen in the doc "VLDB Overall design"

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

Retrieve the current property flags

Returns a WebPushNotification object, which can be used to push mobile notification on a dossier.

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

To get the search engine properties

Retrieves the list of system functions based on the flags.

Returns a populated WebFolder which contains the system styles.

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.

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

Returns a populated WebFolder which contains the user styles.

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

To check if search on project

To check if search engine has been started

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

Move an existing object in the metadata.

Creates an empty element collection associated with the specified attribute

Creates new expression object

To pause crawl on project

To purge specific time stamp change journal

To resume crawl on project

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.

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.

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.

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.

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.

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.

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.

To set change journal to enabled/disabled

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.

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

Set the messageID for get object command.

Set the current property flags

To start crawl on project

To start incremental crawl on project

To start search engine

To stop incremental crawl on project

To stop search engine

This method is for partially updating cube's security filters. Explain for backend implement of cube level's security filter: there is no first class object for cube security filter which actually is combined to user level's security filter in MD, the cube security filter expression is pruned form user level's filter by backend. Note that this method requires include the above 10.8 version for IServer due to changed backend.@return

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

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

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.