filenet.vw.api

Class VWWorkScheduleList

java.lang.Object

filenet.vw.api.VWWorkScheduleList

All Implemented Interfaces:

java.io.Serializable

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

Use this class to create, read, delete, or modify Work Schedule 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 contents of the work schedule definition list to the current isolated region.
VWWorkScheduleDefinition	createWorkScheduleDefinition(java.lang.String aWorkScheduleName) Creates a work schedule definition.
void	deleteWorkScheduleDefinitions(java.lang.String[] theNames, java.lang.String theApplicationSpaceName) Deletes the specified work schedule definitions from the list and the isolated region.
VWWorkScheduleDefinition	getWorkScheduleDefinition(java.lang.String name) Gets the work schedule definition with with specified name from the list.
VWWorkScheduleDefinition[]	getWorkScheduleDefinitions() Gets all work schedule definitions in the list.
java.lang.String[]	getWorkScheduleNames() Gets an array containing the names of the work schedule definitions in the list.
java.lang.StringBuilder	importFromXML(java.io.BufferedReader in, int inputOption) Imports work schedule 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

getWorkScheduleDefinitions

public VWWorkScheduleDefinition[] getWorkScheduleDefinitions()
                                                      throws VWException

Gets all work schedule 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 work schedule definition objects.

Throws:

VWException - Thrown for various reasons.

Since:

CPE 5.2.0.3

getWorkScheduleDefinition

public VWWorkScheduleDefinition getWorkScheduleDefinition(java.lang.String name)
                                                   throws VWException

Gets the work schedule definition with with specified name from the list.

Parameters:

name - The name of the work schedule definition.

Returns:

A work schedule definition object, or null if the work schedule definition is not found in the list.

Throws:

VWException - Thrown for various reasons.

Since:

CPE 5.2.0.3

deleteWorkScheduleDefinitions

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

Deletes the specified work schedule definitions from the list and the isolated region.

Parameters:

theNames - The names of the work schedule 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 work schedule 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 work schedule definition.

Since:

CPE 5.2.0.3

createWorkScheduleDefinition

public VWWorkScheduleDefinition createWorkScheduleDefinition(java.lang.String aWorkScheduleName)
                                                      throws VWException

Creates a work schedule definition.

Parameters:

aWorkScheduleName - The name to be used for the new work schedule definition.

Returns:

The new work schedule definition object.

Throws:

VWException - Thrown for various reasons.

Since:

CPE 5.2.0.3

See Also:

VWWorkScheduleDefinition

getWorkScheduleNames

public java.lang.String[] getWorkScheduleNames()

Gets an array containing the names of the work schedule definitions in the list.

Returns:

The array of work schedule 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 contents of the work schedule definition list to the current isolated region.

Before calling this method, work schedule definition changes reside only in local memory.

Parameters:

theApplicationSpaceName - If an application space name is specified, the user must have write access to the specified application space for the work schedule 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:

CPE 5.2.0.3

importFromXML

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

Imports work schedule definition objects from the specified BufferedReader object.

Parameters:

in - A BufferedReader object from which to read the work schedule object definition(s).

inputOption - One of the following:

• VWXMLRegionMetadata.IMPORT_REPLACE the import will replace current work schedule objects.
• VWXMLRegionMetadata.IMPORT_MERGE the import will merge the data with work schedule 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