filenet.vw.api

Class VWRegionAdministration

java.lang.Object

filenet.vw.api.VWRegionAdministration

All Implemented Interfaces:

java.io.Serializable

public final class VWRegionAdministration
extends java.lang.Object
implements java.io.Serializable

This class provides functions to administer a Workflow System's isolated region.

Since:

PE 5.2.0.0

See Also:

VWSession.fetchRegionAdministration(), Serialized Form

Method Summary

Modifier and Type	Method and Description
void	commit() Saves the region administration changes to the current isolated region.
VWRDBObjectDefinition	createRDBObjectDefinition(java.lang.String theObjectRoot, java.lang.String theLocation) Creates a new VWRDBObjectDefinition object and adds it to the collection.
VWRDBObjectDefinition	createRDBObjectDefinition(java.lang.String theObjectRoot, java.lang.String theType, java.lang.String theLogicalTableName, java.lang.String theLogicalIndexName, java.lang.String theLocation) Creates a new VWRDBObjectDefinition object and adds it to the collection.
void	deleteRDBObjectDefinition(VWRDBObjectDefinition theRDBObjectDefinition) Deletes the specified VWRDBObjectDefinition object from the collection, if found.
VWRDBObjectDefinition	getRDBObjectDefinition(java.lang.String theObjectRoot, java.lang.String theType, java.lang.String theLogicalTableName, java.lang.String theLogicalIndexName) Gets an existing VWRDBObjectDefinition object from the collection.
VWRDBObjectDefinition[]	getRDBObjectDefinitions() Gets the VWRDBObjectDefinition objects from the collection.
java.lang.String[]	getTableSpacesInUse() Gets a list of table space (or file group) names.
boolean	isRegionBackupEnabled() Gets the isolated region backup flag value.
boolean	isRegionLocked() Gets the region lock state.
void	lockRegion(boolean bLock) Locks or unlocks the isolated region
void	setRegionBackupEnabled(boolean bEnabled) Deprecated. PE 5.5.0 The feature is no longer supported

Methods inherited from class java.lang.Object

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

Method Detail

commit

public void commit()
            throws VWException

Saves the region administration changes to the current isolated region.

Before calling this method, region administration changes reside only in local memory.

Throws:

VWException - Thrown if the system encounters an error while attempting to commit the region administration changes to the online repository.

Since:

PE 5.2.0.0

isRegionLocked

public boolean isRegionLocked()
                       throws VWException

Gets the region lock state. This state may be stale; another process may have locked (or unlocked) the region after this state was retrieved.

Returns:

A boolean value of true if the region is locked for a user operation, false otherwise.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

See Also:

VWSession.fetchRegionLockStatus()

lockRegion

public void lockRegion(boolean bLock)
                throws VWException

Locks or unlocks the isolated region

Parameters:

bLock - If true, an attempt is made to lock the region. If false, an attempt is made to unlock the region.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

isRegionBackupEnabled

public boolean isRegionBackupEnabled()
                              throws VWException

Gets the isolated region backup flag value.

Returns:

A value of true if region backup is enabled for the isolated region; false otherwise.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

setRegionBackupEnabled

public void setRegionBackupEnabled(boolean bEnabled)
                            throws VWException

Deprecated. PE 5.5.0 The feature is no longer supported

Sets the isolated region backup flag value.

Parameters:

bEnabled - If true, the table spaces that are in use by the isolated region are examined. If any table spaces are used that are not in the current list of table spaces, an exception is returned. When the changes are committed, additional verification is performed on the server before the isolated region backup flag is enabled.

Throws:

VWException - If the flag can not be set.

Since:

PE 5.2.0.0

See Also:

VWRegionAdministration.commit()

createRDBObjectDefinition

public VWRDBObjectDefinition createRDBObjectDefinition(java.lang.String theObjectRoot,
                                                       java.lang.String theLocation)
                                                throws VWException

Creates a new VWRDBObjectDefinition object and adds it to the collection.

Parameters:

theObjectRoot - A String corresponding to one of the following:

• VWRDBObjectDefinition.STR_PE_DATA
• VWRDBObjectDefinition.STR_PE_INDEX
• VWRDBObjectDefinition.STR_PE_BLOB

theLocation - The name of the table space

Returns:

the new VWRDBObjectDefinition object.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

See Also:

VWRDBObjectDefinition

createRDBObjectDefinition

public VWRDBObjectDefinition createRDBObjectDefinition(java.lang.String theObjectRoot,
                                                       java.lang.String theType,
                                                       java.lang.String theLogicalTableName,
                                                       java.lang.String theLogicalIndexName,
                                                       java.lang.String theLocation)
                                                throws VWException

Creates a new VWRDBObjectDefinition object and adds it to the collection.

Parameters:

theObjectRoot - A String corresponding to one of the following:

• VWRDBObjectDefinition.STR_PE_DATA
• VWRDBObjectDefinition.STR_PE_INDEX
• VWRDBObjectDefinition.STR_PE_BLOB

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

theLogicalTableName - The logical table name. This value can be null.

theLogicalIndexName - The logical index name. This value can be null.

theLocation - The name of the table space or file group.

Returns:

The new VWRDBObjectDefinition object.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

See Also:

VWRDBObjectDefinition

deleteRDBObjectDefinition

public void deleteRDBObjectDefinition(VWRDBObjectDefinition theRDBObjectDefinition)
                               throws VWException

Deletes the specified VWRDBObjectDefinition object from the collection, if found.

Parameters:

theRDBObjectDefinition - The VWRDBObjectDefinition object to delete from the collection.

Throws:

VWException - Thrown if the VWRDBObjectDefinition object is not found and for other various causes.

Since:

PE 5.2.0.0

See Also:

VWRDBObjectDefinition

getRDBObjectDefinition

public VWRDBObjectDefinition getRDBObjectDefinition(java.lang.String theObjectRoot,
                                                    java.lang.String theType,
                                                    java.lang.String theLogicalTableName,
                                                    java.lang.String theLogicalIndexName)
                                             throws VWException

Gets an existing VWRDBObjectDefinition object from the collection.

Parameters:

theObjectRoot - A String corresponding to one of the following:

• VWRDBObjectDefinition.STR_PE_DATA
• VWRDBObjectDefinition.STR_PE_INDEX
• VWRDBObjectDefinition.STR_PE_BLOB

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

theLogicalTableName - The logical table name. This value can be null.

theLogicalIndexName - The logical index name. This value can be null.

Returns:

the VWRDBObjectDefinition object, if found. Otherwise null is returned.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

See Also:

VWRDBObjectDefinition

getRDBObjectDefinitions

public VWRDBObjectDefinition[] getRDBObjectDefinitions()
                                                throws VWException

Gets the VWRDBObjectDefinition objects from the collection.

Returns:

The current set of VWRDBObjectDefinition objects that are in the collection.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

See Also:

VWRDBObjectDefinition

getTableSpacesInUse

public java.lang.String[] getTableSpacesInUse()
                                       throws VWException

Gets a list of table space (or file group) names.

Returns:

A String array containing the names of the table spaces that are currently in use.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0