Package com.microstrategy.web.objects

Interface WebDBRole

All Superinterfaces:

KeyedObject, WebDisplayUnit, WebFeatures, WebObjectInfo, WebPromptSite

public interface WebDBRole
extends WebObjectInfo

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

Since:

MicroStrategy Web 8.0.2

Method Summary

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

Methods inherited from interface com.microstrategy.utils.KeyedObject

_getObKey

Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit

addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected

Methods inherited from interface com.microstrategy.web.objects.WebFeatures

isFeatureAvailable, isFeatureAvailable

Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo

buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

Methods inherited from interface com.microstrategy.web.objects.WebPromptSite

getPromptInstances

Method Detail

getDefaultDBConnection

WebDBConnection getDefaultDBConnection()

Returns the WebDBConnection object used by this WebDBRole

Returns:

WebDBConnection currently used by this DBRole

Since:

MicroStrategy Web 9.0.0

getTableSource

WebTableSource getTableSource()

Returns the WebTableSource object used by this WebDBRole

Returns:

WebTableSource associated with this DBRole

Since:

MicroStrategy Web 9.0.0

getDBMS

WebDBMS getDBMS()

Returns the WebDBMS object used by this WebDBRole

Returns:

WebDBMS associated with this DBRole

Since:

MicroStrategy Web 9.0.0

getDBConnectionType

java.lang.Integer getDBConnectionType()

Returns the type of DB being accessed.

Returns:

integer from EnumDSSXMLDatabaseType

Since:

MicroStrategy Web 9.0.0

getDBRoleType

java.lang.Integer getDBRoleType()

Returns the type of DBRole being accessed.

Returns:

integer from EnumDSSXMLDatabaseType

Since:

MicroStrategy Web 9.0.0

getDBConnectionVersion

java.lang.Integer getDBConnectionVersion()

Returns the version of the DB being accessed

Returns:

integer from EnumDSSXMLDatabaseVersion

Since:

MicroStrategy Web 9.0.0

setDefaultDBConnection

void setDefaultDBConnection(WebDBConnection newConnection)
                     throws java.lang.IllegalArgumentException

Sets which new connection this DBRole will be using

Parameters:

newConnection - WebDBConnection specifying the new connection to be used

Throws:

java.lang.IllegalArgumentException

Since:

MicroStrategy Web 9.0.0

setDefaultDBConnection

void setDefaultDBConnection(WebDBConnection newConnection,
                            boolean embed)

Sets the default DBConnection for this DBRole

Parameters:

newConnection - WebDBConnection representing the connection parameters to be used

embedded - boolean true if newConnection should be embedded in this DBRole's definition

setTableSource

void setTableSource(WebTableSource tbs)

Associate WebTableSource with this DBRole by object

Parameters:

tbs - WebTableSource to be associated

Since:

MicroStrategy Web 9.0.0

setDBMS

void setDBMS(WebDBMS dbms)
      throws java.lang.IllegalArgumentException

Associate WebDBMS with this DBRole by object

Parameters:

dbms - WebDBMS to assoicate with this DBRole

Throws:

java.lang.IllegalArgumentException

Since:

MicroStrategy Web 9.0.0

setDBConnectionType

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

Since:

MicroStrategy Web 9.0.0

setDBRoleType

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

Since:

MicroStrategy Web 9.0.0

setDBConnectionVersion

void setDBConnectionVersion(int newVersion)

Set the new DB version type

Parameters:

newVersion - integer representing a version type from EnumDSSXMLDatabaseVersion

Since:

MicroStrategy Web 9.0.0

getIntmdtStoreDBName

java.lang.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

Since:

MicroStrategy Web 9.0.0

getIntmdtStoreTableSpaceName

java.lang.String getIntmdtStoreTableSpaceName()

Returns the Table Space name used for intermediate table storage

Returns:

String containing the Table Space name

Since:

MicroStrategy Web 9.0.0

getPrimaryDBInstance

WebDBRole getPrimaryDBInstance()

Returns the primary DB instance associated with this DBRole

Returns:

WebDBRole acting as primary DBInstance for this DBRole

Since:

MicroStrategy Web 9.0.0

getDataMartDBInstance

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

Since:

MicroStrategy Web 9.0.0

setIntmdtStoreDBName

void setIntmdtStoreDBName(java.lang.String newName)

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

Parameters:

newName - String containing the new prefix

Since:

MicroStrategy Web 9.0.0

setIntmdtStoreTableSpaceName

void setIntmdtStoreTableSpaceName(java.lang.String newName)

Sets the new Table Space name for intermediate table storage

Parameters:

newName - String containing new Table Space name

Since:

MicroStrategy Web 9.0.0

setPrimaryDBInstance

void setPrimaryDBInstance(WebDBRole primary)

Sets the primary DBInstance for this DBRole

Parameters:

primary - WebDBRole pointing to new primary DBInstance

Since:

MicroStrategy Web 9.0.0

setDataMartDBInstance

void setDataMartDBInstance(WebDBRole instance)
                    throws java.lang.IllegalArgumentException

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:

java.lang.IllegalArgumentException

Since:

MicroStrategy Web 9.0.0

setTablePrefix

void setTablePrefix(java.lang.String newPrefix)
             throws WebObjectsException,
                    java.lang.IllegalArgumentException

Set the value of prefix in WebTableSource. Based on the prefix value will search in Table source folder. If result not found then, it will create a new WebTableSource and it will set same name as prefix and will save to Table source folder. If there is already WebTableSource based on prefix search, then it would update setTableSource(WebTableSource).

Parameters:

newPrefix - Prefix value.

Throws:

WebObjectsException

java.lang.IllegalArgumentException

getPriorityConnectionCount

java.lang.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

Since:

MicroStrategy Web 9.0.0

setPriorityConnectionCount

void setPriorityConnectionCount(int type,
                                int newCount)
                         throws java.lang.IllegalArgumentException

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:

java.lang.IllegalArgumentException

Since:

MicroStrategy Web 9.0.0

toStringFull

java.lang.String toStringFull(java.lang.String prefix)

Returns:

String containing as much textual information about DBRole as possible

Since:

MicroStrategy Web 9.0.0

getMaxDBConnections

java.lang.Integer getMaxDBConnections()

Returns:

integer maximum number of physical connections allowed

Since:

MicroStrategy Web 9.0.0

getMaxDBCost

java.lang.Integer getMaxDBCost()

Returns:

integer Maximum query load allowed

Since:

MicroStrategy Web 9.0.0

setMaxDBConnections

void setMaxDBConnections(int conns)

Parameters:

conns - integer specifying Maximum number of physical connections allowed

Since:

MicroStrategy Web 9.0.0

setMaxDBCost

void setMaxDBCost(int cost)

Parameters:

cost - integer Maximum query load allowed

Since:

MicroStrategy Web 9.0.0

getODBCVersion

int getODBCVersion()
            throws WebObjectsException

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

Returns:

int ODBC version from EnumWebODBCVersion

Throws:

WebObjectsException

Since:

MicroStrategy Web 9.0.1

setODBCVersion

void setODBCVersion(int odbcVersion)
             throws WebObjectsException

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

Parameters:

odbcVersion - int from EnumWebODBCVersion

Throws:

WebObjectsException

Since:

MicroStrategy Web 9.0.1

setForDataImport

void setForDataImport(boolean isForDataImport)

Set whether this DBRole will be used for DataImport

Parameters:

isForDataImport - boolean

isForDataImport

boolean isForDataImport()

Return whether the DBRole will be used for DataImport

Returns:

boolean whether the DBRole is to be used for DataImport

getIconData

java.lang.String getIconData()

setIconData

void setIconData(java.lang.String _iconData)

setDBRoleSubType

void setDBRoleSubType(int subType)

genGetDBRoleConnectionStringXML

java.lang.String genGetDBRoleConnectionStringXML(java.lang.String sessionId,
                                                 java.lang.String objectId)

isManaged

boolean isManaged()

getJobPrioritization

WebJobPrioritization getJobPrioritization()
                                   throws WebObjectsException

Get job prioritization of the DBRole.

Returns:

Throws:

WebObjectsException

saveJobPrioritization

void saveJobPrioritization()
                    throws WebObjectsException

Save job prioritization to metadata.

Throws:

WebObjectsException