Package com.primavera.integration.common

Class DatabaseInstance

java.lang.Object

com.primavera.integration.common.DatabaseInstance

All Implemented Interfaces:

Serializable

public class DatabaseInstance
extends Object
implements Serializable

DatabaseInstance contains information about a database instance, specifically the ID and name. The ID can be used at login time to specify which database instance to connect to. The name is more descriptive and can be presented to a graphical user interface (GUI).

The API setup application ensures that a configuration exists in your primary database. This configuration is created with one database instance by default. To add other instances, use the Primavera Administrator application. See the API's Administrator Guide for more information.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DBTYPE_ORACLE	Constant for Oracle Database Type
static final int	DBTYPE_SQL_SERVER	Constant for SQL Server Database Type

Constructor Summary

Constructors

Constructor	Description
DatabaseInstance(String sDbId, String sDbName, String sDbUrl)	Class constructor specifying database ID database name, and database URL.
DatabaseInstance(String sDbId, String sDbName, String sDbUrl, DBType dbType, String dbEncoding)	Class constructor specifying database ID, name, URL, type, and encoding

Method Summary

Modifier and Type	Method	Description
String	getActualDatabaseName()	Returns the actual database name from the connection url
String	getDatabaseId()	Gets the database ID
String	getDatabaseName()	Gets the database name
String	getDatabaseUrl()	Gets the database URL.
String	getDBEncoding()	Gets the database encoding
int	getDBType()	Gets the database type.
DBType	getDBTypeEnum()	Gets the database type.
String	toString()	Gets a String representation of this object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

DBTYPE_ORACLE

public static final int DBTYPE_ORACLE

Constant for Oracle Database Type

See Also:

• Constant Field Values

DBTYPE_SQL_SERVER

public static final int DBTYPE_SQL_SERVER

Constant for SQL Server Database Type

See Also:

• Constant Field Values

Constructor Details

DatabaseInstance

public DatabaseInstance(String sDbId,
 String sDbName,
 String sDbUrl,
 DBType dbType,
 String dbEncoding)

Class constructor specifying database ID, name, URL, type, and encoding

Parameters:

sDbId - database id

sDbName - database name

sDbUrl - database URL

dbType - database type

dbEncoding - database encoding

DatabaseInstance

public DatabaseInstance(String sDbId,
 String sDbName,
 String sDbUrl)

Class constructor specifying database ID database name, and database URL.

Parameters:

sDbId - database id

sDbName - database name

sDbUrl - database URL

Method Details

getDatabaseId

public String getDatabaseId()

Gets the database ID

Returns:

String database id

getDatabaseName

public String getDatabaseName()

Gets the database name

Returns:

String database name

getDatabaseUrl

public String getDatabaseUrl()

Gets the database URL.

Returns:

String database URL

toString

public String toString()

Gets a String representation of this object. This is the same as the database name.

Overrides:

toString in class Object

Returns:

String database name

getActualDatabaseName

public String getActualDatabaseName()

Returns the actual database name from the connection url

Returns:

String actual database name

getDBEncoding

public String getDBEncoding()

Gets the database encoding

Returns:

String the database encoding

getDBType

public int getDBType()

Gets the database type. See the constants DBTYPE_ORACLE and DBTYPE_SQL_SERVER for the possible values.

Returns:

DBType the database type

getDBTypeEnum

public DBType getDBTypeEnum()

Gets the database type.

Returns:

DBType the database type