Package com.microstrategy.web.objects

Interface WebProjectSource

  • public interface WebProjectSource
    The WebProjectSource object is used to execute project-related tasks. It can be obtained from WebObjectsFactory, and internally it will be associated with that factory. From the associated WebObjectsFactory, this source will retrieve neccessay information needed for performing its task, especially the WebIServerSession associated with the factory.

    It acts as a source for retrieving list of projects and project flags. Note that the getProjects method will return those projects that are loaded on the server, while getAccessibleProjects will use the credentials set on the WebIServerSession object to return only those projects that the user can login to successfully. getRepositoryProjects will return all projects in the repository, regardless of whether they are loaded or not; this method is only useful for server administration.

    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • getProjects

        WebProjectInstances getProjects​(boolean fromIServer)
                         throws WebObjectsException
        Returns the WebProjectInstances object containing all projects that are loaded on the server. Note that the credentials to use for this call come from the WebIServerSession object associated with the WebObjectsFactory object that this object came from. The credentails include: server name and port number. These credentails need to be set up correctly on WebIServerSession before calling this method.
        Parameters:
        fromIServer - boolean used to determine whether WebProjectInstances should come from IServer or Cache
        Returns:
        WebProjectInstances object which is a collection of all loaded projects on the specific intelligence server (corresponding to the session).
        Throws:
        WebObjectsException - Thrown if there is an error retrieving the list.
        Since:
        MicroStrategy Web 9.0.0

      • getProjectsInCluster

        WebProjectInstances getProjectsInCluster()
                                  throws WebObjectsException
        Returns the WebProjectInstances object containing all projects that are loaded on any server in cluster. Note that the credentials to use for this call come from the WebIServerSession object associated with the WebObjectsFactory object that this object came from. The credentails include: server name and port number. These credentails need to be set up correctly on WebIServerSession before calling this method.
        Returns:
        WebProjectInstances object which is a collection of all loaded projects in the cluster of the specific intelligence server (corresponding to the session).
        Throws:
        WebObjectsException - Thrown if there is an error retrieving the list.
        Since:
        MicroStrategy Web 8.0.0

      • getAllProjectsInCluster

        WebProjectInstances getAllProjectsInCluster()
                                     throws WebObjectsException
        Returns the WebProjectInstances object containing all projects in cluster. Note that the credentials to use for this call come from the WebIServerSession object associated with the WebObjectsFactory object that this object came from. The credentails include: server name and port number. These credentails need to be set up correctly on WebIServerSession before calling this method.
        Returns:
        WebProjectInstances object which is a collection of all projects in the cluster of the specific intelligence server (corresponding to the session).
        Throws:
        WebObjectsException - Thrown if there is an error retrieving the list.
        Since:
        MicroStrategy Web Polaris

      • getProjectFlags

        int getProjectFlags()
        This is reserved for future use. It has no effect right now. There is no enumeration associated with the project flags at this time.
        Returns:
        integer indicating the project flags that are set. This is reserved for future use.

      • setProjectFlags

        void setProjectFlags​(int flags)
        This is reserved for future use. It has no effect right now. There is no enumeration associated with the project flags at this time.
        Parameters:
        flags - integer argument specifying the project flags. This is reserved for future use.

      • getProjectStatus

        WebProjectStatus getProjectStatus()
                           throws WebObjectsException
        This method assumes that the session associated with this project source corresponds to a valid project The status of this project is returned
        Returns:
        the WebProjectStatus for the project specified and returns null if properties needed to read the status information do not exist
        Throws:
        WebObjectsException - if there is an error while reading the properties

      • getProjectProperties

        WebPropertySet getProjectProperties​(java.lang.String propertySetName)
                             throws WebObjectsException
        returns the project properties for a given property set name. Note that these properties are returned from a cache and should be used for read-only purposes. In order to write back updated properties, please use saveProjectProperties(WebPropertySet)
        Parameters:
        propertySetName - the property set name
        Returns:
        collection of properties as a WebPropertySet.
        Throws:
        WebObjectsException - if error was encountered on IServer while retrieving the properties.
        Since:
        MicroStrategy Web 8.0.0

      • updateProjectsInCluster

        void updateProjectsInCluster()
                      throws WebObjectsException
        Cause the Intelligence Servers in cluster to load/unload projects according to the latest asymmetric clustering map.
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web 8.0.0

      • checkPrivilege

        boolean checkPrivilege​(java.lang.String projectDSSID,
                       int privilegeType)
                throws WebObjectsException
        Check the privilege based on the project.
        Parameters:
        projectDSSID - - project DSS ID to check.
        privilegeType - - value from EnumDSSXMLPrivilegeTypes
        Returns:
        true if the privilege is enabled
        Throws:
        WebObjectsException - if there is any error while retrieving privileges
        Since:
        MicroStrategy Web 9.0.0

      • getPromptCustomStyles

        WebPromptCustomStyles getPromptCustomStyles()
                                     throws WebObjectsException,
                                            java.lang.IllegalArgumentException
        Returns the prompt custom styles for this project
        Returns:
        The WebPromptCustomStyles for this project. Can be used for retrieving, editing the current custom styles defined for this project
        Throws:
        WebObjectsException - Thrown when error happens during the retrieving.
        java.lang.IllegalArgumentException - Thrown when error happens during the retrieving.
        Since:
        MicroStrategy Web 9.0.0

      • refreshSQLEngineSchema

        void refreshSQLEngineSchema​(java.lang.String sessionID)
                     throws WebObjectsException
        Refresh SQL Engine schema for all nodes in the connected cluster. This is required when COM schema is updated in MD
        Parameters:
        sessionID - - session DSSID
        Throws:
        WebObjectsException