Process Java API: VWDBExecuteConnection (Process API Documentation)

java.lang.Object
- filenet.vw.api.VWDBExecuteConnection

All Implemented Interfaces:

IVWtoXML, java.io.Serializable
```
public final class VWDBExecuteConnection
extends java.lang.Object
implements java.io.Serializable, IVWtoXML
```
This object contains the information needed by workflow system to access a remote database and execute one or more stored procedures.

Since:

PE 5.0.0.0

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int DBTYPE_DB2

static int DBTYPE_MSSQL

static int DBTYPE_ORACLE

Fields
Modifier and Type	Field and Description
`static int`	`DBTYPE_DB2`
`static int`	`DBTYPE_MSSQL`
`static int`	`DBTYPE_ORACLE`

Constructor Summary

Constructors
Constructor and Description
`VWDBExecuteConnection()` Empty constructor
`VWDBExecuteConnection(java.lang.String name, int type, java.lang.String url, java.lang.String dbName, java.lang.String hostName, int dbPort, java.lang.String user, java.lang.String pwd, boolean changed)` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`static java.lang.String`	`constructJdbcUrl(java.lang.String dbHostName, int dbPortNumber, java.lang.String dbName, int dbType)` Construct a sample JDBC URL
`void`	`copy(VWDBExecuteConnection def)` Creates a copy of the given object
`java.lang.String`	`getDbHostName()` Gets the DBExecute connection database host name
`java.lang.String`	`getDbName()` Gets the DBExecute connection database name
`int`	`getDbPort()` Gets the DBExecute connection database port number
`int`	`getDbType()` Gets the DBExecute connection database type
`java.lang.String`	`getDbUserId()` Gets the DBExecute connection database user name
`boolean`	`getHasChanged()` Gets the value of the changed flag
`java.lang.String`	`getName()` Gets the DBExecute connection name
`java.lang.String`	`getPWD()` Deprecated.
`java.lang.String`	`getURL()` Gets the DBExecute connection JDBC URL
`void`	`setDbHostName(java.lang.String dbHostName)` Sets the DBExecute connection database host name
`void`	`setDbName(java.lang.String dbName)` Sets the DBExecute connection database name
`void`	`setDbPort(int port)` Sets the DBExecute connection database port number
`void`	`setDbType(int type)` Sets the DBExecute connection database type
`void`	`setDbUserId(java.lang.String id)` Sets the DBExecute connection database user name
`void`	`setHasChanged(boolean bHasChanged)` Sets the value of the changed flag
`void`	`setName(java.lang.String name)` Sets the DBExecute connection name
`void`	`setPWD(java.lang.String thePWD)` Sets the DBExecute connection database password.
`void`	`setURL(java.lang.String url)` Sets the DBExecute connection JDBC URL
`void`	`toXML(java.lang.StringBuffer theBuffer)` Deprecated. Use `VWXMLConfiguration.makeXMLBlock(IVWtoXML[])`.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DBTYPE_MSSQL
```
public static final int DBTYPE_MSSQL
```
    See Also:
    Constant Field Values
  - DBTYPE_ORACLE
```
public static final int DBTYPE_ORACLE
```
    See Also:
    Constant Field Values
  - DBTYPE_DB2
```
public static final int DBTYPE_DB2
```
    See Also:
    Constant Field Values
- Constructor Detail
  - VWDBExecuteConnection
```
public VWDBExecuteConnection()
```
    Empty constructor
    
    Since:
    
    PE 5.0.0.0
  - VWDBExecuteConnection
```
public VWDBExecuteConnection(java.lang.String name,
                     int type,
                     java.lang.String url,
                     java.lang.String dbName,
                     java.lang.String hostName,
                     int dbPort,
                     java.lang.String user,
                     java.lang.String pwd,
                     boolean changed)
```
    Constructor
    
    Parameters:
    name -
    type - one of the following: {DBTYPE_MSSQL, DBTYPE_ORACLE, DBTYPE_DB2}
    url -
    dbName -
    hostName -
    dbPort -
    user -
    pwd -
    changed -
    Since:
    
    PE 5.0.0.0
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Gets the DBExecute connection name
    
    Returns:
    the DBExecute connection name
    Since:
    
    PE 5.0.0.0
  - setName
```
public void setName(java.lang.String name)
```
    Sets the DBExecute connection name
    
    Parameters:
    name - the DBExecute connection name
    Since:
    
    PE 5.0.0.0
  - getDbType
```
public int getDbType()
```
    Gets the DBExecute connection database type
    
    Returns:
    the DBExecute connection database type
    Since:
    
    PE 5.0.0.0
  - setDbType
```
public void setDbType(int type)
```
    Sets the DBExecute connection database type
    
    Parameters:
    type - one of the following: {DBTYPE_MSSQL, DBTYPE_ORACLE, DBTYPE_DB2}
    Since:
    
    PE 5.0.0.0
  - getURL
```
public java.lang.String getURL()
```
    Gets the DBExecute connection JDBC URL
    
    Returns:
    the DBExecute connection JDBC URL
    Since:
    
    PE 5.0.0.0
  - setURL
```
public void setURL(java.lang.String url)
```
    Sets the DBExecute connection JDBC URL
    
    Parameters:
    url - the DBExecute connection JDBC URL
    Since:
    
    PE 5.0.0.0
    
    See Also:
    VWDBExecuteConnection.constructJdbcUrl(String, int, String, int)
  - getDbName
```
public java.lang.String getDbName()
```
    Gets the DBExecute connection database name
    
    Returns:
    the DBExecute connection database name
    Since:
    
    PE 5.0.0.0
  - setDbName
```
public void setDbName(java.lang.String dbName)
```
    Sets the DBExecute connection database name
    
    Parameters:
    dbName - the DBExecute connection database name
    Since:
    
    PE 5.0.0.0
  - getDbHostName
```
public java.lang.String getDbHostName()
```
    Gets the DBExecute connection database host name
    
    Returns:
    the DBExecute connection database host name
    Since:
    
    PE 5.0.0.0
  - setDbHostName
```
public void setDbHostName(java.lang.String dbHostName)
```
    Sets the DBExecute connection database host name
    
    Parameters:
    dbHostName - the DBExecute connection database host name
    Since:
    
    PE 5.0.0.0
  - getDbPort
```
public int getDbPort()
```
    Gets the DBExecute connection database port number
    
    Returns:
    the DBExecute connection database port number
    Since:
    
    PE 5.0.0.0
  - setDbPort
```
public void setDbPort(int port)
```
    Sets the DBExecute connection database port number
    
    Parameters:
    port - the DBExecute connection database port number
    Since:
    
    PE 5.0.0.0
  - getDbUserId
```
public java.lang.String getDbUserId()
```
    Gets the DBExecute connection database user name
    
    Returns:
    the DBExecute connection database user name
    Since:
    
    PE 5.0.0.0
  - setDbUserId
```
public void setDbUserId(java.lang.String id)
```
    Sets the DBExecute connection database user name
    
    Parameters:
    id - the DBExecute connection database user name
    Since:
    
    PE 5.0.0.0
  - getPWD
```
public java.lang.String getPWD()
```
    Deprecated.
    
    Gets the DBExecute connection database password token.
    
    Returns:
    The password token.
    Since:
    
    PE 5.0.0.0
    
    See Also:
    VWDBExecuteConnection.setPWD(String)
  - setPWD
```
public void setPWD(java.lang.String thePWD)
```
    Sets the DBExecute connection database password.
    
    Parameters:
    thePWD - The DBExecute connection database password.
    Since:
    
    PE 5.0.0.0
  - getHasChanged
```
public boolean getHasChanged()
```
    Gets the value of the changed flag
    
    Returns:
    true if the settings have changed
    Since:
    
    PE 5.0.0.0
  - setHasChanged
```
public void setHasChanged(boolean bHasChanged)
```
    Sets the value of the changed flag
    
    Parameters:
    bHasChanged - the new value of the changed flag
    Since:
    
    PE 5.0.0.0
  - copy
```
public void copy(VWDBExecuteConnection def)
```
    Creates a copy of the given object
    
    Parameters:
    def - a DbExecute connection object
    Since:
    
    PE 5.0.0.0
  - toXML
```
public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
```
    Deprecated. Use VWXMLConfiguration.makeXMLBlock(IVWtoXML[]).
    
    Appends an XML string representing this instance to the buffer specified.
    Warning: This XML string is nonextensible, and cannot be modified in any way.
    
    Specified by:
    
    toXML in interface IVWtoXML
    
    Parameters:
    theBuffer - A StringBuffer that will be appended with the XML content.
    
    Throws:
    
    VWException - Thrown if the specified buffer is null.
    Since:
    
    PE 5.0.0.0
    
    See Also:
    VWXMLConfiguration
  - constructJdbcUrl
```
public static java.lang.String constructJdbcUrl(java.lang.String dbHostName,
                                int dbPortNumber,
                                java.lang.String dbName,
                                int dbType)
                                         throws VWException
```
    Construct a sample JDBC URL
    
    Parameters:
    dbHostName -
    dbPortNumber -
    dbName -
    dbType - one of the following: {DBTYPE_MSSQL, DBTYPE_ORACLE, DBTYPE_DB2}
    
    Returns:
    the sample JDBC URL
    
    Throws:
    
    VWException
    Since:
    
    PE 5.2.0.0

Methods inherited from class java.lang.Object

DBTYPE_MSSQL

DBTYPE_ORACLE

DBTYPE_DB2

VWDBExecuteConnection

VWDBExecuteConnection

getName

setName

getDbType

setDbType

getURL

setURL

getDbName

setDbName

getDbHostName

setDbHostName

getDbPort

setDbPort

getDbUserId

setDbUserId

getPWD

setPWD

getHasChanged

setHasChanged

copy

toXML

constructJdbcUrl