Package com.microstrategy.web.objects

Interface WebObjectSource

  • public interface WebObjectSource
    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 WebObjectInfo.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.

    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • getObject

        WebObjectInfo getObject​(java.lang.String objectID,
                        int objectType,
                        boolean populate)
                 throws WebObjectsException,
                        java.lang.IllegalArgumentException
        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.
        java.lang.IllegalArgumentException - Thrown if the object ID is invalid.

      • getObject

        WebObjectInfo getObject​(java.lang.String objectID,
                        int objectType)
                 throws WebObjectsException,
                        java.lang.IllegalArgumentException
        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.
        java.lang.IllegalArgumentException - Thrown if the object ID is invalid.

      • getObject

        WebObjectInfo getObject​(java.lang.String objectID,
                        int objectType,
                        int objectSubType)
                 throws WebObjectsException,
                        java.lang.IllegalArgumentException
        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.
        java.lang.IllegalArgumentException - Thrown if the object ID is invalid.

      • getObject

        WebObjectInfo getObject​(java.lang.String objectID,
                        int objectType,
                        int objectSubType,
                        boolean populate)
                 throws WebObjectsException,
                        java.lang.IllegalArgumentException
        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.
        java.lang.IllegalArgumentException - Thrown if the object ID is invalid.

      • getUsersInBulk

        java.util.List<WebObjectInfo> getUsersInBulk​(java.util.List<java.lang.String> userIds)
                                      throws WebObjectsException,
                                             java.lang.IllegalArgumentException
        Returns a list of WebObjectInfo object representing the user which resides in metadata. This method will return the existing objects only and will not throw any exception if the userId is not existing.
        Parameters:
        userIds - list of user id
        Returns:
        A list of WebObjectInfo user object corresponding to the given DSS ID.
        Throws:
        WebObjectsException - Thrown if the Intelligence Server api call failed or the response is invalid.
        java.lang.IllegalArgumentException - Thrown if the user ID is invalid.

      • getObjectByPath

        WebObjectInfo getObjectByPath​(java.lang.String fullPath,
                              int objectType,
                              int objectSubType)
                       throws WebObjectsException
        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.
        java.lang.IllegalArgumentException - Thrown if the object ID is invalid.
        Since:
        MicroStrategy Web 9.0.0

      • getObjectByPath

        WebObjectInfo getObjectByPath​(java.lang.String fullPath,
                              int objectType)
                       throws WebObjectsException
        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.
        java.lang.IllegalArgumentException - Thrown if the object ID is invalid.
        Since:
        MicroStrategy Web 9.0.0

      • deleteObject

        void deleteObject​(java.lang.String objectID,
                  int objectType)
           throws WebObjectsException
        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.

      • deleteObject

        void deleteObject​(WebObjectInfo object)
           throws WebObjectsException
        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.
        Since:
        MicroStrategy Web 7.5.2

      • moveObject

        void moveObject​(java.lang.String objectID,
                int objectType,
                java.lang.String newName)
         throws WebObjectsException
        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
        Since:
        MicroStrategy Web 7.5.0

      • certifyObject

        java.lang.String certifyObject​(java.lang.String objectID,
                               int objectType,
                               boolean certify)
                        throws WebObjectsException
        Certify or decertify object in the metadata.
        Parameters:
        objectID - The DSS ID of the object to certify or decertify.
        objectType - The type of the object in the metadata EnumDSSXMLObjectTypes, only support document and report type now.
        certify - 1 for certify object, 0 for decertify object
        Returns:
        A String A json string returned for the object certify result, the format would be as below: Certified: [{"oid":"#Object_ID#","result_code":0,"ctfs":1, "crfid": "#Certifier's ID", "ctfr":"#Certifer's name#","ctfl":"#Certifer's login#","ctft":"#certify time#"}] Not certified: [{ "oid":"#Object_ID#", "result_code":0,"ctfs":0}] Error: [{ "oid":"#Object_ID#", "result_code":"#result code#","er":"#Error_string#"}]
        Throws:
        WebObjectsException - Thrown if an error occurs upon attempting to move the object

      • getFolderID

        java.lang.String getFolderID​(int folderName)
                      throws WebObjectsException
        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.

      • createFolder

        java.lang.String createFolder​(java.lang.String folderName,
                              java.lang.String parentFolderID)
                       throws WebObjectsException
        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.

      • createFolder

        java.lang.String createFolder​(java.lang.String folderName,
                              java.lang.String parentFolderID,
                              java.lang.String folderDesc)
                       throws WebObjectsException
        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.

      • getNewSearchObject

        WebSearch getNewSearchObject()
        Returns a WebSearch object, which can be used to execute a search.
        Returns:
        A WebSearch object.

      • getBlockBegin

        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.
        See Also:
        setBlockBegin(int)

      • setBlockBegin

        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:
        getBlockBegin()

      • getBlockCount

        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.
        See Also:
        setBlockCount(int)

      • setBlockCount

        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:
        getBlockCount()

      • getFlags

        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:
        setFlags(int)

      • setFlags

        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:
        getFlags()

      • getLevel

        int getLevel()
        Returns the current level parameter, which will be used when obtaining folder contents.
        Returns:
        The current level setting.
        See Also:
        setLevel(int)

      • setLevel

        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:
        getLevel()

      • getMessageID

        java.lang.String getMessageID()
        Returns the messageID for get object command.
        Returns:
        the messageID for get object command.

      • setMessageID

        void setMessageID​(java.lang.String _messageID)
        Set the messageID for get object command.
        Parameters:
        _messageID - the messageID for get object command

      • getAllStyles

        WebFolder getAllStyles()
                throws WebObjectsException
        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.
        Since:
        MicroStrategy Web 8.0.0

      • saveObjects

        void saveObjects​(java.util.HashMap<WebObjectInfo,​WebFolder> objectInfos)
          throws WebObjectsException
        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.
        Parameters:
        HashMap - to save.
        Throws:
        WebObjectsException - thrown if an error is encountered by IServer.

      • save

        WebObjectInfo save​(WebObjectInfo objectToSave)
            throws WebObjectsException
        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.
        Since:
        MicroStrategy Web 7.5.0

      • save

        WebObjectInfo save​(WebObjectInfo objectToSave,
                   java.lang.String name)
            throws WebObjectsException
        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.
        Since:
        MicroStrategy Web 7.5.0

      • uploadWallet

        java.lang.String uploadWallet​(WebObjectInfo objectToSave)
                       throws WebObjectsException
        Uploads the wallet binary in order to parse and retrieve services list.
        Parameters:
        objectToSave - A wallet to upload.
        Returns:
        String wallet services.
        Throws:
        WebObjectsException - thrown if an error is encountered by IServer.

      • save

        WebObjectInfo save​(WebObjectInfo objectToSave,
                   java.lang.String name,
                   WebFolder folder)
            throws WebObjectsException
        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.
        Since:
        MicroStrategy Web 7.5.0

      • save

        WebObjectInfo save​(WebObjectInfo objectToSave,
                   WebFolder folder)
            throws WebObjectsException
        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.
        Since:
        MicroStrategy Web 7.5.0

      • copy

        WebObjectInfo copy​(WebObjectInfo sourceObject,
                   java.lang.String targetObjectName)
            throws WebObjectsException
        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.
        Since:
        MicroStrategy Web 7.5.0

      • copy

        WebObjectInfo copy​(WebObjectInfo sourceObject,
                   java.lang.String targetObjectName,
                   WebFolder location)
            throws WebObjectsException
        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.
        Since:
        MicroStrategy Web 7.5.0

      • copy

        WebObjectInfo copy​(WebObjectInfo sourceObject,
                   WebFolder location)
            throws WebObjectsException
        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.
        Since:
        MicroStrategy Web 7.5.0

      • getNewObject

        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.
        Since:
        MicroStrategy Web 7.5.0

      • getNewObject

        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.
        Since:
        MicroStrategy Web 7.5.0

      • getNewObject

        WebObjectInfo getNewObject​(int objectType,
                           java.lang.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.
        Since:
        MicroStrategy Web 7.5.0

      • getNewObject

        WebObjectInfo getNewObject​(int objectType,
                           int subType,
                           java.lang.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.
        Since:
        MicroStrategy Web 7.5.0

      • getActiveServerDef

        WebServerDef getActiveServerDef()
                         throws WebObjectsException
        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:
        The WebServerDef object which is being used by the server.
        Throws:
        WebObjectsException - Thrown if an error occurs.
        Since:
        MicroStrategy Web 7.5.2

      • getObjectFromState

        WebObjectInfo getObjectFromState​(java.lang.String state)
                          throws java.lang.IllegalArgumentException,
                                 WebObjectsException
        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:
        A WebObjectInfo object corresponding to the given state.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the state passed is invalid.
        WebObjectsException
        Since:
        MicroStrategy Web 7.5.2

      • getTransformationRoles

        WebFolder getTransformationRoles()
                          throws WebObjectsException
        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.
        Since:
        MicroStrategy Web 8.0.0

      • validateObjectName

        void validateObjectName​(java.lang.String name)
                 throws WebObjectsException
        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.
        Since:
        MicroStrategy Web 8.0.0

      • getMDXCubeSource

        WebMDXCubeSource getMDXCubeSource()
        This method will return the WebMDXCubeSource interface, which can be used to initiate cube browsing and cube object browsing requests.
        Returns:
        An instance of WebMDXCubeSource.
        Since:
        MicroStrategy Web 8.0.2

      • getSystemFunctions

        WebFunctionFolders getSystemFunctions​(int functionFlags)
                               throws WebObjectsException
        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.

      • newExpression

        WebExpression newExpression()
        Creates new expression object
        Since:
        MicroStrategy Web 9.0.1

      • newElements

        WebElements newElements​(WebAttribute attribute)
        Creates an empty element collection associated with the specified attribute
        Parameters:
        attribute - attribute.
        Since:
        MicroStrategy Web 9.0.1

      • newPrompts

        WebPrompts newPrompts​(java.lang.String messageId,
                      int objectType)

      • getTransactionElement

        TransactionElement getTransactionElement​(java.lang.String transactionReportID)
                                  throws WebObjectsException
        Parameters:
        transactionReportID -
        Returns:
        the transactionElement with ID equals transactionReportID
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web 9.0.3

      • getPropertyFlags

        int getPropertyFlags()
        Retrieve the current property flags
        Returns:
        int binary OR of EnumDSSXMLPropertyXmlFlags

      • setPropertyFlags

        void setPropertyFlags​(int flags)
        Set the current property flags
        Parameters:
        flags - int binary OR of EnumDSSXMLPropertyXmlFlags

      • getParsedMetric

        WebParsedMetric getParsedMetric​(java.lang.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.
        Parameters:
        metricID - a specific metric ID, or null for creating a new metric
        Returns:
        a parsed metric object
        Since:
        MicroStrategy Web 9.2.2

      • getParsedModel

        WebParsedModel getParsedModel​(java.lang.String objectId,
                              int targetType)
        Get a parsed model object with the specified object ID. The objectId argument could be null when trying to create a new object.
        Parameters:
        objectId - a specific object ID, or null for creating a new object
        targetType - the type of the object, in EnumDSSXMLObjectTypes
        Returns:
        a parsed model
        Since:
        MicroStrategy Web 11.2

      • getParsedModel

        WebParsedModel getParsedModel​(java.lang.String objectId,
                              int targetType,
                              java.util.OptionalInt dssType)
        Get a parsed model object with the specified object ID. The objectId argument could be null when trying to create a new object.
        Parameters:
        objectId - a specific object ID, or null for creating a new object
        targetType - the type of the object, in EnumDSSXMLObjectTypes
        dssType - the dssType set optionally for the parse model command, in EnumDSSXMLObjectTypes
        Returns:
        a parsed model
        Since:
        MicroStrategy Web 11.2.1

      • getParsedModel

        WebParsedModel getParsedModel​(java.lang.String objectId,
                              int targetType,
                              java.util.OptionalInt dssType,
                              java.lang.String messageId)
        Get a parsed model object with the specified object ID. The objectId argument could be null when trying to create a new object.
        Parameters:
        objectId - a specific object ID, or null for creating a new object
        targetType - the type of the object, in EnumDSSXMLObjectTypes
        dssType - the dssType set optionally for the parse model command, in EnumDSSXMLObjectTypes
        messageId - the messageId of a report instance if the model needs to perform on a report instance rather than metadata
        Returns:
        a parsed model
        Since:
        MicroStrategy Web 11.3.4

      • purgeChangeJournal

        void purgeChangeJournal​(java.lang.String timestamp,
                        java.lang.String comment,
                        int allProjects)
                 throws WebObjectsException
        To purge specific time stamp change journal
        Parameters:
        timestamp - . Time stamp used to purge the target change journal, if not specified, purge all change journals
        comment - . The comment of change journal purge.
        isAllProjects - . To specify if the configuration and all projects is enabled
        Throws:
        WebObjectsException

      • setChangeJournalStatus

        void setChangeJournalStatus​(boolean enabled,
                            java.lang.String comment,
                            int allProjects)
                     throws WebObjectsException
        To set change journal to enabled/disabled
        Parameters:
        enabled - . Set change journal enabled/disabled.
        comment - . The comment of change journal enabled/disabled.
        allProjects - . To specify if the configuration and all projects is enabled
        Throws:
        WebObjectsException

      • changeObjectID

        void changeObjectID​(java.lang.String objectId,
                    int type,
                    java.lang.String newId)
             throws WebObjectsException
        Change DSS ID of the given object.
        Parameters:
        objectID - The DSS ID of the object to be changed.
        objectType - The type of the object to be changed. This value comes from EnumDSSXMLObjectTypes.
        newId - The new DSS ID.
        Throws:
        WebObjectsException

      • listTranslations

        WebLocaleTranslation[] listTranslations​(WebObjectInfo objectInfo,
                                        java.lang.String[] keyList,
                                        int[] localeIDList,
                                        int qualities)
                                 throws WebObjectsException,
                                        java.lang.IllegalArgumentException
        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 containers 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
        java.lang.IllegalArgumentException

      • getAndSetExternalSourceSessionInfo

        void getAndSetExternalSourceSessionInfo​(int flags,
                                        java.lang.String sourceID,
                                        int sourceType,
                                        java.lang.String u,
                                        java.lang.String localeDateNumber,
                                        java.util.Map<java.lang.String,​java.lang.String> tokenInfo)
                                 throws WebObjectsException
        Throws:
        WebObjectsException

      • createLocale

        java.lang.String createLocale​(java.lang.String name,
                              int localeID,
                              int localeFlag,
                              java.lang.String folderID,
                              int objectFlag)
                       throws WebObjectsException
        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
        Throws:
        WebObjectsException

      • manipulateLocaleLinkedToInterfaceLanguage

        java.lang.String manipulateLocaleLinkedToInterfaceLanguage​(java.lang.String name,
                                                           int localeID,
                                                           java.lang.String interfaceLanguageId,
                                                           int localeFlag,
                                                           java.lang.String folderID,
                                                           int objectFlag)
                                                    throws WebObjectsException
        Allows the caller to manipulate the locale object linked to interface language.
        Parameters:
        name - the name of locale
        localeID - locale id
        interfaceLanguageId - interface language 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 manipulated locale
        Throws:
        WebObjectsException

      • updateTranslation

        java.lang.String updateTranslation​(java.lang.String objectID,
                                   int objectType,
                                   java.lang.String key,
                                   int localeID,
                                   java.lang.String name)
                            throws WebObjectsException,
                                   java.lang.IllegalArgumentException
        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
        java.lang.IllegalArgumentException

      • deleteTranslation

        java.lang.String deleteTranslation​(java.lang.String objectID,
                                   int objectType,
                                   java.lang.String key,
                                   int localeID)
                            throws WebObjectsException,
                                   java.lang.IllegalArgumentException
        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
        java.lang.IllegalArgumentException

      • updateTranslations

        java.lang.String updateTranslations​(WebObjectInfo objectInfo,
                                    WebLocaleTranslation[] toUpdateList,
                                    WebLocaleTranslation[] toDeleteList)
                             throws WebObjectsException,
                                    java.lang.IllegalArgumentException
        This manipulation allows user to add, update, and delete any translations at any locale for one object.
        Parameters:
        objectInfo - object
        toUpdateList -
        toDeleteList -
        Returns:
        the number of deleted translations.
        Throws:
        WebObjectsException
        java.lang.IllegalArgumentException

      • isSearchEngineStarted

        boolean isSearchEngineStarted()
                       throws WebObjectsException
        To check if search engine has been started
        Returns:
        true if it has started, false if it has not
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web Cloud OM

      • rebuildSearchIndex

        void rebuildSearchIndex​(java.lang.String projectID)
                 throws WebObjectsException
        To rebuild the search index of the project
        Parameters:
        projectID - , the GUID of the project to rebuild the index
        Throws:
        WebObjectsException

      • startCrawl

        void startCrawl​(java.lang.String projectID)
         throws WebObjectsException
        To start crawl on project
        Parameters:
        projectID - , the GUID of the project to start crawl
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web Cloud OM

      • pauseCrawl

        void pauseCrawl​(java.lang.String projectID)
         throws WebObjectsException
        To pause crawl on project
        Parameters:
        projectID - , the GUID of the project to pause crawl
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web Cloud OM

      • resumeCrawl

        void resumeCrawl​(java.lang.String projectID)
          throws WebObjectsException
        To resume crawl on project
        Parameters:
        projectID - , the GUID of the project to resume crawl
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web Cloud OM

      • destroyCrawl

        void destroyCrawl​(java.lang.String projectID)
           throws WebObjectsException
        To destroy crawl on project
        Parameters:
        projectID - , the GUID of the project to destroy crawl
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web Cloud OM

      • enableSearch

        void enableSearch​(java.lang.String projectID,
                  boolean enable)
           throws WebObjectsException
        To enable/disable project
        Parameters:
        projectID - , the GUID of the project to enable search
        enable - , true to enable search on the project specified by projectID, false to disable.
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web Cloud OM

      • isSearchEnabled

        boolean isSearchEnabled​(java.lang.String projectID)
                 throws WebObjectsException
        To check if search on project
        Parameters:
        projectID - , the GUID of the project to stop incremental crawl
        Returns:
        true if search is enabled; false if disabled.
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web Cloud OM

      • startIncrementalCrawl

        void startIncrementalCrawl​(java.lang.String projectID)
                    throws WebObjectsException
        To start incremental crawl on project
        Parameters:
        projectID - , the GUID of the project to start incremental crawl
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web Cloud OM

      • stopIncrementalCrawl

        void stopIncrementalCrawl​(java.lang.String projectID)
                   throws WebObjectsException
        To stop incremental crawl on project
        Parameters:
        projectID - , the GUID of the project to stop incremental crawl
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web Cloud OM

      • getLeanObject

        WebObjectInfo getLeanObject​(java.lang.String objectID,
                            int objectType)
                     throws WebObjectsException
        To get the device/transmitter object
        Parameters:
        objectID - . The id of the device/transmitter object
        objectType - . The type of the object. This value comes from EnumDSSXMLObjectTypes.
        Returns:
        device/transmitter object
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web Cloud OM

      • getNumberOfDependencies

        int getNumberOfDependencies​(java.lang.String objectID,
                            int objectType,
                            int objectSubType)
                     throws WebObjectsException,
                            java.lang.IllegalArgumentException
        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
        java.lang.IllegalArgumentException

      • getCubeSecurityFiltersXML

        java.lang.String getCubeSecurityFiltersXML​(java.lang.String userID,
                                           java.lang.String cubeID)
                                    throws WebObjectsException
        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.
        Parameters:
        userID - user id
        cubeID - cube id
        Returns:
        Throws:
        WebObjectsException

      • getCubeSecurityFilters

        java.util.Map<java.lang.String,​WebExpression> getCubeSecurityFilters​(java.lang.String cubeID)
                                                                    throws WebObjectsException
        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.
        Parameters:
        cubeID - cube id
        Returns:
        Throws:
        WebObjectsException

      • getCubeSecurityFilter

        WebExpression getCubeSecurityFilter​(java.lang.String userID,
                                    java.lang.String cubeID)
                             throws WebObjectsException
        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.
        Parameters:
        userID - user id
        cubeID - cube id
        Returns:
        Throws:
        WebObjectsException

      • updateCubeSecurityFilters

        java.lang.String updateCubeSecurityFilters​(java.lang.String cubeID,
                                           java.util.Map<java.lang.String,​WebExpression> cubeSecurityFilters)
                                    throws WebObjectsException
        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.
        Parameters:
        cubeID - cube id
        cubeSecurityFilters - userId map to cube security filter expression
        Returns:
        Throws:
        WebObjectsException

      • getObjectVLDBInheritedValuesAsJSON

        java.lang.String getObjectVLDBInheritedValuesAsJSON​(java.lang.String objectID,
                                                    int objectType,
                                                    java.lang.String propertySetID,
                                                    java.util.List<java.lang.Integer> propertyIDs)
                                             throws WebObjectsException
        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"
        Parameters:
        objectID - object id
        objectType - object type, which can be found in EnumDSSXMLObjectTypes.java
        propertySetID - the id of VLDB property set, which is a GUID
        propertyIDs - the ids of VLDB properties that you want to get value
        Returns:
        the json string that contains the VLDB inherited property value
        Throws:
        WebObjectsException

      • getInstanceVLDBInheritedValuesAsJSON

        java.lang.String getInstanceVLDBInheritedValuesAsJSON​(java.lang.String messageID,
                                                      int objectType,
                                                      java.lang.String propertySetID,
                                                      java.util.List<java.lang.Integer> propertyIDs)
                                               throws WebObjectsException
        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"
        Parameters:
        messageID - message id of report/document instance
        objectType - object type, which can be found in EnumDSSXMLObjectTypes.java
        propertySetID - the id of VLDB property set, which is a GUID
        propertyIDs - the ids of VLDB properties that you want to get value
        Returns:
        the json string that contains the VLDB inherited property value
        Throws:
        WebObjectsException