public class

ProjectInformation

extends Object
java.lang.Object
   ↳ com.microstrategy.web.app.ProjectInformation

Class Overview

This class contains the basic information regarding a project that can exist on a server

Summary

Public Constructors
ProjectInformation()
This constructor is deprecated. see ProjectInformation(WebProjectInstance, String, String, int, int, String, Locale) Class Constructor
ProjectInformation(WebProjectInstance projectDetails, String serverName, int portNumber)
This constructor is deprecated. see ProjectInformation(WebProjectInstance, String, String, int, int, String, Locale)
ProjectInformation(WebProjectInstance projectDetails, String serverName, String serverAlias, int portNumber, int errorCode, String user, Locale locale)
Class constructor
Public Methods
int getErrorCode()
Get the error code generated while trying to connect to the server
Locale getLocale()
int getPortNumber()
Get the port that needs to be accessed on the server to get the project
WebProjectInstance getProjectDetails()
Get the project information on the instance
String getProjectName()
Utility method for retrieving the name of the project represented by this instance.
int getProjectStatus()
Utility method for retrieving the status of the project represented by this instance.
String getServerAlias()
Get the alias of the server where the project is located
String getServerName()
Get the name of the server where the project is located
String getUser()
Get the name of user that generated the error code
void setErrorCode(int errorCode)
Set the error code generated while trying to connect to the server
void setPortNumber(int portNumber)
Set the port that needs to be accessed on the server to get the project
void setProjectDetails(WebProjectInstance projectDetails)
Set the project information on the instance
void setServerAlias(String serverAlias)
Set the alias of the server where the project is located
void setServerName(String serverName)
Set the name of the server where the project is located
void setUser(String user)
Set the name of the user that generated the error code
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ProjectInformation ()

This constructor is deprecated.
see ProjectInformation(WebProjectInstance, String, String, int, int, String, Locale) Class Constructor

public ProjectInformation (WebProjectInstance projectDetails, String serverName, int portNumber)

This constructor is deprecated.
see ProjectInformation(WebProjectInstance, String, String, int, int, String, Locale)

Class constructor

Parameters
projectDetails a WebProjectInstance instance holding the project information
serverName where the server is registered
portNumber the prot that should be accessed to get the server

public ProjectInformation (WebProjectInstance projectDetails, String serverName, String serverAlias, int portNumber, int errorCode, String user, 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

Public Methods

public int getErrorCode ()

Get the error code generated while trying to connect to the server

Returns
  • id of the error if any found

public Locale getLocale ()

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

public WebProjectInstance getProjectDetails ()

Get the project information on the instance

Returns

public 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.

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

public String getServerAlias ()

Get the alias of the server where the project is located

Returns
  • a String with the alias of the server

public String getServerName ()

Get the name of the server where the project is located

Returns
  • a String with the name of the server

public String getUser ()

Get the name of user that generated the error code

Returns
  • a String with the name of the user

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

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

public void setProjectDetails (WebProjectInstance projectDetails)

Set the project information on the instance

Parameters
projectDetails a WebProjectInstance instance holding the project information

public void setServerAlias (String serverAlias)

Set the alias of the server where the project is located

Parameters
serverAlias a String with a valid server alias

public void setServerName (String serverName)

Set the name of the server where the project is located

Parameters
serverName a String with a valid server name

public void setUser (String user)

Set the name of the user that generated the error code

Parameters
user user that generated the error code