filenet.vw.api

Class VWRegionFieldList

java.lang.Object

filenet.vw.api.VWRegionFieldList

All Implemented Interfaces:

java.io.Serializable

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

Use this class to create, read, delete, or modify region field definition lists.

Since:

CPE 5.2.0.3

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	commit(java.lang.String theApplicationSpaceName) Saves the region field definition List to the current isolated region.
VWRegionFieldDefinition	createRegionFieldDefinition(java.lang.String theRegionFieldName, java.lang.Object theValue) Creates a region field definition and adds it to the local memory list.
void	deleteRegionFieldDefinitions(java.lang.String[] theNames, java.lang.String theApplicationSpaceName) Deletes the specified region field definitions from the list and the isolated region.
VWRegionFieldDefinition	getRegionFieldDefinition(java.lang.String name) Gets the region field definition with with specified name from the list.
VWRegionFieldDefinition[]	getRegionFieldDefinitions() Gets all region field definitions in the list.
java.lang.String[]	getRegionFieldNames() Gets an array containing the names of the region field definitions in the list.
java.lang.StringBuilder	importFromXML(java.io.BufferedReader in, int inputOption) Imports region field definition objects from the specified BufferedReader object.

Methods inherited from class java.lang.Object

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

Method Detail

getRegionFieldDefinitions

public VWRegionFieldDefinition[] getRegionFieldDefinitions()
                                                    throws VWException

Gets all region field definitions in the list. This may include items retrieved from the server and items that have been added to the list which may not yet be persisted to the server.

Returns:

An array of region field definition objects.

Throws:

VWException - Thrown for various reasons.

Since:

CPE 5.2.0.3

getRegionFieldDefinition

public VWRegionFieldDefinition getRegionFieldDefinition(java.lang.String name)
                                                 throws VWException

Gets the region field definition with with specified name from the list.

Parameters:

name - The name of the region field definition.

Returns:

A VWRegionFieldDefinition object, if the region field definition is found.

Throws:

VWException - Thrown if specified region field definition is not in the list.

Since:

CPE 5.2.0.3

deleteRegionFieldDefinitions

public void deleteRegionFieldDefinitions(java.lang.String[] theNames,
                                         java.lang.String theApplicationSpaceName)
                                  throws VWException

Deletes the specified region field definitions from the list and the isolated region.

Parameters:

theNames - The names of the region field definitions to be deleted.

theApplicationSpaceName - If an application space name is specified, the user must have write access to the specified application space for the region field definitions to be deleted. If null is specified for this parameter, the user must be a member of the SysAdmin or SysConfig administrative groups.

Throws:

VWException - Thrown if the method cannot delete a region field definition.

Since:

CPE 5.2.0.3

createRegionFieldDefinition

public VWRegionFieldDefinition createRegionFieldDefinition(java.lang.String theRegionFieldName,
                                                           java.lang.Object theValue)
                                                    throws VWException

Creates a region field definition and adds it to the local memory list.

Parameters:

theRegionFieldName - The name of the region field definition. A region field definition having the specified name must not exist in the local memory list.

theValue - The value of the new region field definition.

Throws:

VWException - Thrown if the system encounters an error while attempting to create the region field definition.

Since:

CPE 5.2.0.3

See Also:

VWRegionFieldDefinition

getRegionFieldNames

public java.lang.String[] getRegionFieldNames()

Gets an array containing the names of the region field definitions in the list.

Returns:

The array of region field definition names, or null if the list is empty.

Since:

CPE 5.2.0.3

commit

public void commit(java.lang.String theApplicationSpaceName)
            throws VWException

Saves the region field definition List to the current isolated region.

Before calling this method, region field definition changes reside only in local memory. If there is no change to the list or the list is empty, this is a noop.

Parameters:

theApplicationSpaceName - If an application space name is specified, the user must have write access to the specified application space for the region field definitions to be deleted. If null is specified for this parameter, the user must be a member of the SysAdmin or SysConfig administrative groups.

Throws:

VWException - Thrown if the system encounters an error while attempting to commit the contents of the list to the isolated region.

Since:

PE 5.2.0.3

importFromXML

public java.lang.StringBuilder importFromXML(java.io.BufferedReader in,
                                             int inputOption)
                                      throws VWException

Imports region field definition objects from the specified BufferedReader object.

Parameters:

in - A BufferedReader object from which to read the region field object definition(s).

inputOption - One of the following:

• VWXMLRegionMetadata.IMPORT_REPLACE the import will replace current region field objects.
• VWXMLRegionMetadata.IMPORT_MERGE the import will merge the data with region field objects. Objects will be added if they do not already exist on the server.

Returns:

A StringBuilder containing an import log.

Throws:

VWException

Since:

CPE 5.2.0.3