public interface

WebProjectReference

com.microstrategy.web.objects.WebProjectReference

Class Overview

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.

Summary

Public Methods
abstract WebProjectSettings getConfigurationSettings(int type)
Returns a WebProjectSettings object containing all the configuration settings for the specified type of configuration from EnumDSSXMLProjectConfigurationSettingType.
abstract 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).
abstract int getID()
Returns the internal ID of the project reference.
abstract int getLoadFlag()
Returns the load flag setting for the project reference, from EnumDSSXMLProjectLoadOption.
abstract int getMetadataVersion()
Returns the metadata version of the project.
abstract String getName()
This method returns the name of the project reference.
abstract String getProjectDSSID()
Returns the DSS ID of the project.
abstract WebObjectInfo getProjectInfo()
Returns the WebObjectInfo object corresponding to the project that the reference refers to.
abstract WebProjectSettings getProjectSettings()
Returns a collection of settings pertaining to this project.
abstract WebDBRole getStatisticsDBRole()
Returns a WebDBRole object which is the statistic database for this project.
abstract void setLoadFlag(int loadFlag)
Sets the load flag setting for the project reference.
abstract void setStatisticsDBRole(WebDBRole wdr)
Sets the statistic database for this project.

Public Methods

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

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

public abstract int getID ()

Returns the internal ID of the project reference.

Returns
  • The internal ID of the project reference.

public abstract int getLoadFlag ()

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

Returns
  • The current load flag setting for the reference.

public abstract int getMetadataVersion ()

Returns the metadata version of the project.

Returns
  • The metadata version of the project.

public abstract String getName ()

This method returns the name of the project reference.

Returns
  • The name of the project reference.

public abstract String getProjectDSSID ()

Returns the DSS ID of the project.

Returns
  • The DSS ID of the project

public abstract WebObjectInfo getProjectInfo ()

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.

public abstract WebProjectSettings getProjectSettings ()

Returns a collection of settings pertaining to this project.

Returns

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

public abstract void setLoadFlag (int loadFlag)

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
UnsupportedOperationException

public abstract void setStatisticsDBRole (WebDBRole wdr)

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