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 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 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 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 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 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
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract Integer getDBConnectionType ()

Returns the type of DB being accessed.

Returns

public abstract Integer getDBConnectionVersion ()

Returns the version of the DB being accessed

Returns

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

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

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

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

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 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 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 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
Throws
IllegalArgumentException

public abstract String toStringFull (String prefix)

Returns
  • String containing as much textual information about DBRole as possible