Package com.microstrategy.web.objects

Interface WebProjectReference

public interface WebProjectReference

This interface represents a project reference which is registered with a WebServerDef object. WebProjectReference objects can only exist within the context of a WebProjectReferences collection.

Since:

MicroStrategy Web 7.5.0

Method Summary

Modifier and Type	Method	Description
WebProjectSettings	getConfigurationSettings(int type)	Returns a WebProjectSettings object containing all the configuration settings for the specified type of configuration from EnumDSSXMLProjectConfigurationSettingType.
WebProjectSettings	getConfigurationSettingsFromModule(int type, int module)	Returns a WebProjectSettings object containing all the configuration settings for the specified type of configuration from EnumDSSXMLProjectConfigurationSettingType and the specified module within that type (EnumDSSXMLNotificationModuleID or EnumDSSXMLStatisticModuleID).
int	getID()	Returns the internal ID of the project reference.
int	getLoadFlag()	Returns the load flag setting for the project reference, from EnumDSSXMLProjectLoadOption.
int	getMetadataVersion()	Returns the metadata version of the project.
java.lang.String	getName()	This method returns the name of the project reference.
java.lang.String	getProjectDSSID()	Returns the DSS ID of the project.
WebObjectInfo	getProjectInfo()	Returns the WebObjectInfo object corresponding to the project that the reference refers to.
WebProjectSettings	getProjectSettings()	Returns a collection of settings pertaining to this project.
WebDBRole	getStatisticsDBRole()	Returns a WebDBRole object which is the statistic database for this project.
void	setLoadFlag(int loadFlag)	Sets the load flag setting for the project reference.
void	setStatisticsDBRole(WebDBRole wdr)	Sets the statistic database for this project.

Method Detail

getName

java.lang.String getName()

This method returns the name of the project reference.

Returns:

The name of the project reference.

getProjectDSSID

java.lang.String getProjectDSSID()

Returns the DSS ID of the project.

Returns:

The DSS ID of the project

getLoadFlag

int getLoadFlag()

Returns the load flag setting for the project reference, from EnumDSSXMLProjectLoadOption.

Returns:

The current load flag setting for the reference.

setLoadFlag

void setLoadFlag(int loadFlag)
          throws java.lang.UnsupportedOperationException

Sets the load flag setting for the project reference. This should be a value from EnumDSSXMLProjectLoadOption.

Parameters:

loadFlag - The load flag to use for the project reference.

Throws:

java.lang.UnsupportedOperationException

getProjectInfo

WebObjectInfo getProjectInfo()
                      throws WebObjectsException

Returns the WebObjectInfo object corresponding to the project that the reference refers to.

Returns:

A WebObjectInfo object corresponding to the project reference. This object will not be populated.

Throws:

WebObjectsException - Thrown if an error occurs when obtaining the object.

getID

int getID()

Returns the internal ID of the project reference.

Returns:

The internal ID of the project reference.

getProjectSettings

WebProjectSettings getProjectSettings()

Returns a collection of settings pertaining to this project.

Returns:

A WebProjectSettings collection, containing all settings for this project.

Since:

MicroStrategy Web 7.5.2

getMetadataVersion

int getMetadataVersion()

Returns the metadata version of the project.

Returns:

The metadata version of the project.

Since:

MicroStrategy Web 7.5.2

getConfigurationSettingsFromModule

WebProjectSettings getConfigurationSettingsFromModule(int type,
                                                      int module)

Returns a WebProjectSettings object containing all the configuration settings for the specified type of configuration from EnumDSSXMLProjectConfigurationSettingType and the specified module within that type (EnumDSSXMLNotificationModuleID or EnumDSSXMLStatisticModuleID).

Parameters:

type - int from EnumDSSXMLProjectConfigurationSettingType

module - int specifying the module within the specified setting type

Returns:

WebProjectSettings

Since:

MicroStrategy Web 9.0.0

getConfigurationSettings

WebProjectSettings getConfigurationSettings(int type)

Returns a WebProjectSettings object containing all the configuration settings for the specified type of configuration from EnumDSSXMLProjectConfigurationSettingType. This method assumes there are no modules for the specified settings type. If modules are found the settings for the first module are returned.

Parameters:

type - int from EnumDSSXMLProjectConfigurationSettingType

Returns:

WebProjectSettings

Since:

MicroStrategy Web 9.0.0

getStatisticsDBRole

WebDBRole getStatisticsDBRole()

Returns a WebDBRole object which is the statistic database for this project. If there is no statistic database for this project, it will return null. This object will not be populated.

Returns:

WebDBRole

Since:

MicroStrategy Web 9.0.0

setStatisticsDBRole

void setStatisticsDBRole(WebDBRole wdr)
                  throws WebObjectsException

Sets the statistic database for this project.

Parameters:

wdr - The database to use for statistic purpose. If it is null, the existing statistics DB Role will be removed.

Throws:

WebObjectsException

Since:

MicroStrategy Web 9.0.0