Package com.microstrategy.web.app

Class ProjectInformation

  • public class ProjectInformation
extends java.lang.Object
    This class contains the basic information regarding a project that can exist on a server
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Constructor Detail

      • ProjectInformation

        public ProjectInformation​(WebProjectInstance projectDetails,
                          java.lang.String serverName,
                          java.lang.String serverAlias,
                          int portNumber,
                          int errorCode,
                          java.lang.String user,
                          java.util.Locale locale)
        Class constructor
        Parameters:
        projectDetails - a WebProjectInstance instance holding the project information
        serverName - where the server is registered
        serverAlias - the alias of the server
        portNumber - the port that should be accessed to get the server
        errorCode - error code that happened while trying to connect to this server
        user - user that generated the error code

    • Method Detail

      • setProjectDetails

        public void setProjectDetails​(WebProjectInstance projectDetails)
        Set the project information on the instance
        Parameters:
        projectDetails - a WebProjectInstance instance holding the project information

      • getProjectName

        public java.lang.String getProjectName()
        Utility method for retrieving the name of the project represented by this instance. The complete project information can be retrieved from the WebProjectInstance instance available with the getProjectDetails method.
        Returns:
        String with the name of the project. It will return null if it cannot be retrieved.
        Since:
        MicroStrategy Web 8.0.0

      • getProjectStatus

        public int getProjectStatus()
        Utility method for retrieving the status of the project represented by this instance. The complete project information can be retrieved from the WebProjectInstance instance available with the getProjectDetails method.
        Returns:
        int value with the status of the project. It will return EnumDSSXMLProjectStatus.DssXmlProjectStatusOffline if it cannot be retrieved.
        Since:
        MicroStrategy Web 8.0.0

      • getProjectDetails

        public WebProjectInstance getProjectDetails()
        Get the project information on the instance
        Returns:
        a WebProjectInstance instance holding the project information

      • setServerName

        public void setServerName​(java.lang.String serverName)
        Set the name of the server where the project is located
        Parameters:
        serverName - a String with a valid server name

      • getServerName

        public java.lang.String getServerName()
        Get the name of the server where the project is located
        Returns:
        a String with the name of the server

      • setServerAlias

        public void setServerAlias​(java.lang.String serverAlias)
        Set the alias of the server where the project is located
        Parameters:
        serverAlias - a String with a valid server alias

      • getServerAlias

        public java.lang.String getServerAlias()
        Get the alias of the server where the project is located
        Returns:
        a String with the alias of the server

      • setUser

        public void setUser​(java.lang.String user)
        Set the name of the user that generated the error code
        Parameters:
        user - user that generated the error code

      • getUser

        public java.lang.String getUser()
        Get the name of user that generated the error code
        Returns:
        a String with the name of the user

      • setPortNumber

        public void setPortNumber​(int portNumber)
        Set the port that needs to be accessed on the server to get the project
        Parameters:
        portNumber - valid port number

      • getPortNumber

        public int getPortNumber()
        Get the port that needs to be accessed on the server to get the project
        Returns:
        port number where the project can be found

      • setErrorCode

        public void setErrorCode​(int errorCode)
        Set the error code generated while trying to connect to the server
        Parameters:
        errorCode - id of the error if any found

      • getErrorCode

        public int getErrorCode()
        Get the error code generated while trying to connect to the server
        Returns:
        id of the error if any found

      • getLocale

        public java.util.Locale getLocale()