VWRDBObjectDefinition (Process API Documentation)

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public final class VWRDBObjectDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
This class encapsulates the definition of a relational database object.

Since:

PE 5.2.0.0

See Also:

VWRegionAdministration.createRDBObjectDefinition(String, String), VWRegionAdministration.getRDBObjectDefinition(String, String, String, String), VWSystemAdministration.setRDBObjectLocation(String, String), Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`STR_PE_BLOB` Value of "pe_blob".
`static java.lang.String`	`STR_PE_DATA` Value of "pe_data".
`static java.lang.String`	`STR_PE_INDEX` Value of "pe_index".
`static java.lang.String`	`STR_TYPE_EVENT_LOG` Value of "log".
`static java.lang.String`	`STR_TYPE_QUEUE` Value of "queue".
`static java.lang.String`	`STR_TYPE_ROSTER` Value of "roster".
`static java.lang.String`	`STR_TYPE_TABLE` Value of "table".

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Creates a clone of this `VWRDBObjectDefinition` object.
`int`	`getIsolatedRegionNumber()` Gets the isolated region number.
`java.lang.String`	`getLocation()` Gets the table space (or file group) name.
`java.lang.String`	`getLogicalIndexName()` Gets the logical index name.
`java.lang.String`	`getLogicalTableName()` Gets the logical table name.
`java.lang.String`	`getObjectRoot()` Gets the object root value.
`java.lang.String`	`getType()` Gets the object type.
`boolean`	`hasChanged()` Indicates whether this `VWRDBObjectDefinition` object has changed.
`void`	`setLocation(java.lang.String theLocation)` Sets the table space (or file group) name.
`void`	`setLogicalIndexName(java.lang.String theLogicalIndexName)` (Optional) Sets the logical index name
`void`	`setLogicalTableName(java.lang.String theLogicalTableName)` (Optional) Sets the logical table name.
`void`	`setObjectRoot(java.lang.String theObjectRoot)` Sets the object root value.
`void`	`setType(java.lang.String theType)` (Optional) Sets the object type.
`java.lang.String`	`toString()` Gets the string representation of this `VWRDBObjectDefinition` object.

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

- Field Detail
  - STR_PE_DATA
```
public static final java.lang.String STR_PE_DATA
```
    Value of "pe_data". The object root used for the data table space (or file group).
    
    See Also:
    
    Constant Field Values
  - STR_PE_INDEX
```
public static final java.lang.String STR_PE_INDEX
```
    Value of "pe_index". The object root used for the index table space (or file group).
    
    See Also:
    
    Constant Field Values
  - STR_PE_BLOB
```
public static final java.lang.String STR_PE_BLOB
```
    Value of "pe_blob". The object root used for the blob table space (or file group).
    
    See Also:
    
    Constant Field Values
  - STR_TYPE_QUEUE
```
public static final java.lang.String STR_TYPE_QUEUE
```
    Value of "queue". The object root used for the type property, which is optional.
    
    See Also:
    
    Constant Field Values
  - STR_TYPE_ROSTER
```
public static final java.lang.String STR_TYPE_ROSTER
```
    Value of "roster". Used for the type property, which is optional.
    
    See Also:
    
    Constant Field Values
  - STR_TYPE_EVENT_LOG
```
public static final java.lang.String STR_TYPE_EVENT_LOG
```
    Value of "log". Used for the type property, which is optional.
    
    See Also:
    
    Constant Field Values
  - STR_TYPE_TABLE
```
public static final java.lang.String STR_TYPE_TABLE
```
    Value of "table". Used for the type property, which is optional.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getObjectRoot
```
public java.lang.String getObjectRoot()
                               throws VWException
```
    Gets the object root value.
    Returns:
    The object root value, which will be one of the following:
    
    VWRDBObjectDefinition.STR_PE_DATA
    
    VWRDBObjectDefinition.STR_PE_INDEX
    
    VWRDBObjectDefinition.STR_PE_BLOB
    Throws:
    
    VWException - Thrown for various causes.
    
    Since:
    
    PE 5.2.0.0
  - setObjectRoot
```
public void setObjectRoot(java.lang.String theObjectRoot)
                   throws VWException
```
    Sets the object root value.
    Parameters:
    theObjectRoot - A String corresponding to one of the following:
    
    VWRDBObjectDefinition.STR_PE_DATA
    
    VWRDBObjectDefinition.STR_PE_INDEX
    
    VWRDBObjectDefinition.STR_PE_BLOB
    Throws:
    
    VWException - Thrown for various causes.
    
    Since:
    
    PE 5.2.0.0
  - getIsolatedRegionNumber
```
public int getIsolatedRegionNumber()
                            throws VWException
```
    Gets the isolated region number.
    
    Returns:
    
    The isolated region number.
    
    Throws:
    
    VWException - Thrown for various causes.
    
    Since:
    
    PE 5.2.0.0
  - getType
```
public java.lang.String getType()
                         throws VWException
```
    Gets the object type.
    Returns:
    A String corresponding to one of the following:
    
    VWRDBObjectDefinition.STR_TYPE_QUEUE
    
    VWRDBObjectDefinition.STR_TYPE_ROSTER
    
    VWRDBObjectDefinition.STR_TYPE_EVENT_LOG
    
    VWRDBObjectDefinition.STR_TYPE_TABLE
    
    or null
    Throws:
    
    VWException - Thrown for various causes.
    
    Since:
    
    PE 5.2.0.0
  - setType
```
public void setType(java.lang.String theType)
             throws VWException
```
    (Optional) Sets the object type.
    Parameters:
    theType - A String corresponding to one of the following:
    
    VWRDBObjectDefinition.STR_TYPE_QUEUE
    
    VWRDBObjectDefinition.STR_TYPE_ROSTER
    
    VWRDBObjectDefinition.STR_TYPE_EVENT_LOG
    
    VWRDBObjectDefinition.STR_TYPE_TABLE
    
    or null
    Throws:
    
    VWException - Thrown for various causes, including invalid type.
    
    Since:
    
    PE 5.2.0.0
  - getLogicalTableName
```
public java.lang.String getLogicalTableName()
                                     throws VWException
```
    Gets the logical table name.
    
    Returns:
    
    The logical table name (this may be null).
    
    Throws:
    
    VWException - Thrown for various causes.
    
    Since:
    
    PE 5.2.0.0
  - setLogicalTableName
```
public void setLogicalTableName(java.lang.String theLogicalTableName)
                         throws VWException
```
    (Optional) Sets the logical table name.
    
    Parameters:
    
    theLogicalTableName - the logical table name (this can be null).
    
    Throws:
    
    VWException - Thrown for various causes.
    
    Since:
    
    PE 5.2.0.0
  - getLogicalIndexName
```
public java.lang.String getLogicalIndexName()
                                     throws VWException
```
    Gets the logical index name.
    
    Returns:
    
    The logical index name (this may be null).
    
    Throws:
    
    VWException - Thrown for various causes.
    
    Since:
    
    PE 5.2.0.0
  - setLogicalIndexName
```
public void setLogicalIndexName(java.lang.String theLogicalIndexName)
                         throws VWException
```
    (Optional) Sets the logical index name
    
    Parameters:
    
    theLogicalIndexName - the logical index name (this can be null).
    
    Throws:
    
    VWException - Thrown for various causes.
    
    Since:
    
    PE 5.2.0.0
  - getLocation
```
public java.lang.String getLocation()
                             throws VWException
```
    Gets the table space (or file group) name.
    
    Returns:
    
    The table space (or file group) name.
    
    Throws:
    
    VWException - Thrown for various causes.
    
    Since:
    
    PE 5.2.0.0
  - setLocation
```
public void setLocation(java.lang.String theLocation)
                 throws VWException
```
    Sets the table space (or file group) name. This will be validated when this object is committed to the server.
    
    Parameters:
    
    theLocation - The table space (or file group) name.
    
    Throws:
    
    VWException - Thrown for various causes.
    
    Since:
    
    PE 5.2.0.0
  - hasChanged
```
public boolean hasChanged()
                   throws VWException
```
    Indicates whether this VWRDBObjectDefinition object has changed.
    
    Returns:
    
    A value of true, if this object has been updated; false otherwise.
    
    Throws:
    
    VWException - Thrown for various causes.
    
    Since:
    
    PE 5.2.0.0
  - toString
```
public java.lang.String toString()
```
    Gets the string representation of this VWRDBObjectDefinition object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A canonical string containing the property values: object root, type, logical table name and logical index name. Any null property values are omitted from the result. Example string: "pe_data.1"
    
    Since:
    
    PE 5.2.0.0
  - clone
```
public java.lang.Object clone()
```
    Creates a clone of this VWRDBObjectDefinition object.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    A clone of this instance.
    
    Since:
    
    PE 5.2.0.0

Methods inherited from class java.lang.Object

STR_PE_DATA

STR_PE_INDEX

STR_PE_BLOB

STR_TYPE_QUEUE

STR_TYPE_ROSTER

STR_TYPE_EVENT_LOG

STR_TYPE_TABLE

getObjectRoot

setObjectRoot

getIsolatedRegionNumber

getType

setType

getLogicalTableName

setLogicalTableName

getLogicalIndexName

setLogicalIndexName

getLocation

setLocation

hasChanged

toString

clone