Summary: Methods | Inherited Methods | [Expand All]

public interface

WebDBRole

implements WebObjectInfo

com.microstrategy.web.objects.WebDBRole

Class Overview

The WebDBRole interface represents a DB Role object in metadata. A DBRole object is a first class object.

Summary

Public Methods
abstract String	genGetDBRoleConnectionStringXML(String sessionId, String objectId)
abstract Integer	getDBConnectionType() Returns the type of DB being accessed.
abstract Integer	getDBConnectionVersion() Returns the version of the DB being accessed
abstract WebDBMS	getDBMS() Returns the `WebDBMS` object used by this WebDBRole
abstract Integer	getDBRoleType() Returns the type of DBRole being accessed.
abstract WebDBRole	getDataMartDBInstance() Returns a `WebDBRole` pointing to a DB that this DBRole is pointing to.
abstract WebDBConnection	getDefaultDBConnection() Returns the `WebDBConnection` object used by this WebDBRole
abstract String	getIconData()
abstract String	getIntmdtStoreDBName() Returns a String containing the name of the DB to store intermediate tables
abstract String	getIntmdtStoreTableSpaceName() Returns the Table Space name used for intermediate table storage
abstract Integer	getMaxDBConnections()
abstract Integer	getMaxDBCost()
abstract int	getODBCVersion() Retrieve the ODBC version from the properties.
abstract WebDBRole	getPrimaryDBInstance() Returns the primary DB instance associated with this DBRole
abstract Integer	getPriorityConnectionCount(int type) Set the number of connections to the DB reserved for specified priority jobs
abstract WebTableSource	getTableSource() Returns the `WebTableSource` object used by this WebDBRole
abstract boolean	isForDataImport() Return whether the DBRole will be used for DataImport
abstract boolean	isManaged()
abstract void	setDBConnectionType(int newType) Changes the type of DB the DBRole will be connecting to
abstract void	setDBConnectionVersion(int newVersion) Set the new DB version type
abstract void	setDBMS(WebDBMS dbms) Associate `WebDBMS` with this DBRole by object
abstract void	setDBRoleSubType(int subType)
abstract void	setDBRoleType(int newType) Changes the type of DB the DBRole will be connecting to
abstract void	setDataMartDBInstance(WebDBRole instance) Sets the DBInstance that points to the same DB as this DBRole.
abstract void	setDefaultDBConnection(WebDBConnection newConnection, boolean embed) Sets the default DBConnection for this DBRole
abstract void	setDefaultDBConnection(WebDBConnection newConnection) Sets which new connection this DBRole will be using
abstract void	setForDataImport(boolean isForDataImport) Set whether this DBRole will be used for DataImport
abstract void	setIconData(String _iconData)
abstract void	setIntmdtStoreDBName(String newName) Sets the prefix to be used for table names in this DBRole
abstract void	setIntmdtStoreTableSpaceName(String newName) Sets the new Table Space name for intermediate table storage
abstract void	setMaxDBConnections(int conns)
abstract void	setMaxDBCost(int cost)
abstract void	setODBCVersion(int odbcVersion) Set the ODBC version on the properties.
abstract void	setPrimaryDBInstance(WebDBRole primary) Sets the primary DBInstance for this DBRole
abstract void	setPriorityConnectionCount(int type, int newCount) Set the number of connections to the DB reserved for specified priority jobs
abstract void	setTableSource(WebTableSource tbs) Associate `WebTableSource` with this DBRole by object
abstract String	toStringFull(String prefix)

[Expand]

Inherited Methods

From interface com.microstrategy.utils.KeyedObject

From interface com.microstrategy.web.objects.WebDisplayUnit

abstract void	addDetails(boolean details) This method will add or remove details from the display unit.
abstract void	applyVisitor(DisplayUnitsVisitor visitor, boolean deep)
abstract boolean	canHighlight()
abstract WebDisplayUnits	getChildUnits() Returns the collection of child display units, or null if the object is not a collection.
abstract String	getDisplayName() Returns the display name associated with this object.
abstract int	getDisplayUnitType() Returns the type of display unit that this object represents.
abstract String	getID() Returns the DSS ID of the display unit.
abstract boolean	hasDetails() Returns whether this display unit currently has details enabled.
abstract void	highlightUnit() Sets this display unit to be highlighted.
abstract void	highlightUnit(boolean details) Sets this display unit to be highlighted.
abstract boolean	isHighlighted() Returns whether this unit is highlighted.
abstract boolean	isObjectInfo() Returns true if underlying Web Object can be cast to `WebObjectInfo`.
abstract boolean	isSelected() Returns whether this display unit is selected.
abstract void	setDisplayName(String displayName) This method will set the value of the display name.
abstract void	setSelected(boolean selected) Sets the current unit's selection status.

From interface com.microstrategy.web.objects.WebFeatures

From interface com.microstrategy.web.objects.WebObjectInfo

abstract void	buildShortObjectAttributes(WebXMLBuilder builder)
abstract void	buildShortXML(WebXMLBuilder builder)
abstract String	getAbbreviation() Returns the abbreviation of this object.
abstract int	getAccessGranted() Returns the current access granted on this object, if available.
abstract SimpleList	getAncestors() Returns a `SimpleList` containing the ancestors of this object, if they exist in the object XML.
abstract WebCertifiedInfo	getCertifiedInfo()
abstract String[]	getComments() Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object.
abstract String	getContainerDid()
abstract String	getContainerType()
abstract String	getCreationTime() Returns the creation time of this object, if that information is available.
abstract long	getCreationTimeStamp() Get the object creation timestamp in millisecond.
abstract String	getDataSources()
abstract String	getDescription() Returns the description of the object.
abstract int	getExtendedType() The current extended type
abstract WebObjectsFactory	getFactory() Returns WebObjectsFactory
abstract int	getFlags() Returns the flags which determine what data to populate upon calling populate.
abstract String	getID() Returns the DSS ID of the object, if one exists.
abstract String	getIconPath() Return the icon path for the object
abstract String	getModificationTime() Returns the last modification time of the object, if that information is available.
abstract long	getModificationTimeStamp() Get the object modification timestamp in millisecond.
abstract String	getName() Returns the name of this object.
abstract boolean	getNonSchedulable() Get flag of whether the object is not schedulable
abstract int	getOtherNameTransCount() Returns the count of name translations for locales other than the current effective locale.
abstract WebObjectInfo	getOwner() Returns a WebObjectInfo object which corresponds to the owner of this object.
abstract WebFolder	getParent() Returns the parent folder of the current object, if it exists.
abstract int	getPreSaveAsFlags() Returns the flags which determine the previous save as prompt flag.
abstract String	getProjectId()
abstract String	getProjectName()
abstract int	getPropertyFlags() Retrieve the current property flags
abstract SimpleList	getPropertySetFilter() Returns an editable `SimpleList` where you can specify the list of propertySets that the getPropertySets call should be limited to Note that this filter is not retained in the state.
abstract WebPropertyGroup	getPropertySets() Returns the property sets associated with this object.
abstract WebRecommendationInfo	getRecommendationInfo() This contains all the information related to a recommendation search
abstract WebObjectSecurity	getSecurity() Returns the `WebObjectSecurity` object associated with this WebObjectInfo object.
abstract int	getState() Returns the state of the object.
abstract int	getSubType() Returns the subtype of the object.
abstract int	getType() Returns the type of this object.
abstract String	getVersionID() Returns the Version ID of the object, if one exists.
abstract WebViewMediaSettings	getViewMediaSettings()
abstract int	getVisualizationViewMode()
abstract String	getXML(boolean encode) Returns the XML representation of this object.
abstract String	getXML() Returns the XML representation of this object.
abstract boolean	hasOwner()
abstract boolean	isAncestorNamedFolder(int folderName) Returns whether the named folder is this object's ancestor.
abstract boolean	isDirty() Returns whether this object has been modified to be different from the object in metadata.
abstract boolean	isEmbedded()
abstract boolean	isHidden() Returns whether the object is a hidden object.
abstract boolean	isNew() Returns whether this object is newly created at client side, which is not in the metadata.
abstract boolean	isPopulated() Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.
abstract void	populate(String xml) Populates the fields on this object by loading the given object definition XML.
abstract void	populate() Populates the fields on this object by asking the Intelligence Server for the object definition.
abstract void	setAbbreviation(String abbreviation)
abstract void	setComments(String[] comments) Set the long description of the object as an array of strings.
abstract void	setDataSources(String dataSourcesXML)
abstract void	setDescription(String description) Sets the description of the object.
abstract void	setExtendedType(int extendedType) Set the current extended type
abstract void	setFlags(int flags) Sets the flags which determine what data to populate upon calling populate.
abstract void	setHidden(boolean hidden) Sets whether the object is a hidden object.
abstract void	setIconPath(String iconPath) Set the icon path for the object
abstract void	setName(String _name)
abstract void	setNonSchedulable(boolean nonSchedulable) Set flag of whether the object is not schedulable
abstract void	setPreSaveAsFlags(int flags) Sets the flags which determine the previous save as prompt flag.
abstract void	setPropertyFlags(int flags) Set the current property flags

From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract String genGetDBRoleConnectionStringXML (String sessionId, String objectId)

public abstract Integer getDBConnectionType ()

Returns the type of DB being accessed.

Returns

integer from EnumDSSXMLDatabaseType

public abstract Integer getDBConnectionVersion ()

Returns the version of the DB being accessed

Returns

integer from EnumDSSXMLDatabaseVersion

public abstract WebDBMS getDBMS ()

Returns the WebDBMS object used by this WebDBRole

Returns

WebDBMS associated with this DBRole

public abstract Integer getDBRoleType ()

Returns the type of DBRole being accessed.

Returns

integer from EnumDSSXMLDatabaseType

public abstract WebDBRole getDataMartDBInstance ()

Returns a WebDBRole pointing to a DB that this DBRole is pointing to. Used for Data Mart optimization

Returns

WebDBRole pointint to same DB this DBRole is pointing to

public abstract WebDBConnection getDefaultDBConnection ()

Returns the WebDBConnection object used by this WebDBRole

Returns

WebDBConnection currently used by this DBRole

public abstract String getIconData ()

public abstract String getIntmdtStoreDBName ()

Returns a String containing the name of the DB to store intermediate tables

Returns

String containing the DB name where intermediate tables are stored

public abstract String getIntmdtStoreTableSpaceName ()

Returns the Table Space name used for intermediate table storage

Returns

String containing the Table Space name

public abstract Integer getMaxDBConnections ()

Returns

integer maximum number of physical connections allowed

public abstract Integer getMaxDBCost ()

Returns

integer Maximum query load allowed

public abstract int getODBCVersion ()

Retrieve the ODBC version from the properties. This calls getPropertySets() internally so if the object is going to be populated prior to calling this method, it is best to populate with the flag DssXmlObjectProperties. This call can only be made to an object that already exists in the metadata.

Returns

int ODBC version from EnumWebODBCVersion

Throws

WebObjectsException

public abstract WebDBRole getPrimaryDBInstance ()

Returns the primary DB instance associated with this DBRole

Returns

WebDBRole acting as primary DBInstance for this DBRole

public abstract Integer getPriorityConnectionCount (int type)

Set the number of connections to the DB reserved for specified priority jobs

Parameters

type	Integer from `EnumXmlPriorityType` depicting what priority will be set

Returns

Integer number of connections allowed for the specified priority

public abstract WebTableSource getTableSource ()

Returns the WebTableSource object used by this WebDBRole

Returns

WebTableSource associated with this DBRole

public abstract boolean isForDataImport ()

Return whether the DBRole will be used for DataImport

Returns

boolean whether the DBRole is to be used for DataImport

public abstract boolean isManaged ()

public abstract void setDBConnectionType (int newType)

Changes the type of DB the DBRole will be connecting to

Parameters

newType	integer representing the type of the new DB to be accessed by this DBRole from `EnumDSSXMLDatabaseType`

public abstract void setDBConnectionVersion (int newVersion)

Set the new DB version type

Parameters

newVersion	integer representing a version type from `EnumDSSXMLDatabaseVersion`

public abstract void setDBMS (WebDBMS dbms)

Associate WebDBMS with this DBRole by object

Parameters

dbms	`WebDBMS` to assoicate with this DBRole

Throws

IllegalArgumentException

public abstract void setDBRoleSubType (int subType)

public abstract void setDBRoleType (int newType)

Changes the type of DB the DBRole will be connecting to

Parameters

newType	integer representing the type of the new DB to be accessed by this DBRoleType from `EnumDSSXMLDatabaseType`

public abstract void setDataMartDBInstance (WebDBRole instance)

Sets the DBInstance that points to the same DB as this DBRole. Used for Data Mart optimization

Parameters

instance	`WebDBRole` pointing to the new Data Mart DBInstance

Throws

IllegalArgumentException

public abstract void setDefaultDBConnection (WebDBConnection newConnection, boolean embed)

Sets the default DBConnection for this DBRole

Parameters

newConnection	`WebDBConnection` representing the connection parameters to be used

public abstract void setDefaultDBConnection (WebDBConnection newConnection)

Sets which new connection this DBRole will be using

Parameters

newConnection	`WebDBConnection` specifying the new connection to be used

Throws

IllegalArgumentException

public abstract void setForDataImport (boolean isForDataImport)

Set whether this DBRole will be used for DataImport

Parameters

isForDataImport	boolean

public abstract void setIconData (String _iconData)

public abstract void setIntmdtStoreDBName (String newName)

Sets the prefix to be used for table names in this DBRole

Parameters

newName	String containing the new prefix

public abstract void setIntmdtStoreTableSpaceName (String newName)

Sets the new Table Space name for intermediate table storage

Parameters

newName	String containing new Table Space name

public abstract void setMaxDBConnections (int conns)

Parameters

conns	integer specifying Maximum number of physical connections allowed

public abstract void setMaxDBCost (int cost)

Parameters

cost	integer Maximum query load allowed

public abstract void setODBCVersion (int odbcVersion)

Set the ODBC version on the properties. This calls getPropertySets() internally so if the object is going to be populated prior to calling this method, it is best to populate with the flag DssXmlObjectProperties. This call can only be made to an object that already exists in the metadata.

Parameters

odbcVersion	int from `EnumWebODBCVersion`

Throws

	WebObjectsException
WebObjectsException

public abstract void setPrimaryDBInstance (WebDBRole primary)

Sets the primary DBInstance for this DBRole

Parameters

primary	`WebDBRole` pointing to new primary DBInstance

public abstract void setPriorityConnectionCount (int type, int newCount)

Set the number of connections to the DB reserved for specified priority jobs

Parameters

type	Integer from `EnumXmlPriorityType` depicting what priority will be set
newCount	Integer number of connections allowed for the specified priority

Throws

IllegalArgumentException

public abstract void setTableSource (WebTableSource tbs)

Associate WebTableSource with this DBRole by object

Parameters

tbs	`WebTableSource` to be associated

public abstract String toStringFull (String prefix)

Returns

String containing as much textual information about DBRole as possible

Interfaces

Classes

Enums

Exceptions

WebDBRole

Class Overview

Summary

Public Methods

public abstract String genGetDBRoleConnectionStringXML (String sessionId, String objectId)

public abstract Integer getDBConnectionType ()

Returns

public abstract Integer getDBConnectionVersion ()

Returns

public abstract WebDBMS getDBMS ()

Returns

public abstract Integer getDBRoleType ()

Returns

public abstract WebDBRole getDataMartDBInstance ()

Returns

public abstract WebDBConnection getDefaultDBConnection ()

Returns

public abstract String getIconData ()

public abstract String getIntmdtStoreDBName ()

Returns

public abstract String getIntmdtStoreTableSpaceName ()

Returns

public abstract Integer getMaxDBConnections ()

Returns

public abstract Integer getMaxDBCost ()

Returns

public abstract int getODBCVersion ()

Returns

Throws

public abstract WebDBRole getPrimaryDBInstance ()

Returns

public abstract Integer getPriorityConnectionCount (int type)

Parameters

Returns

public abstract WebTableSource getTableSource ()

Returns

public abstract boolean isForDataImport ()

Returns

public abstract boolean isManaged ()

public abstract void setDBConnectionType (int newType)

Parameters

public abstract void setDBConnectionVersion (int newVersion)

Parameters

public abstract void setDBMS (WebDBMS dbms)

Parameters

Throws

public abstract void setDBRoleSubType (int subType)

public abstract void setDBRoleType (int newType)

Parameters

public abstract void setDataMartDBInstance (WebDBRole instance)

Parameters

Throws

public abstract void setDefaultDBConnection (WebDBConnection newConnection, boolean embed)

Parameters

public abstract void setDefaultDBConnection (WebDBConnection newConnection)

Parameters

Throws

public abstract void setForDataImport (boolean isForDataImport)

Parameters

public abstract void setIconData (String _iconData)

public abstract void setIntmdtStoreDBName (String newName)

Parameters

public abstract void setIntmdtStoreTableSpaceName (String newName)

Parameters

public abstract void setMaxDBConnections (int conns)

Parameters

public abstract void setMaxDBCost (int cost)

Parameters

public abstract void setODBCVersion (int odbcVersion)

Parameters

Throws

public abstract void setPrimaryDBInstance (WebDBRole primary)

Parameters

public abstract void setPriorityConnectionCount (int type, int newCount)

Parameters

Throws