filenet.vw.api

Class VWSLAList

java.lang.Object

filenet.vw.api.VWSLAList

All Implemented Interfaces:

java.io.Serializable

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

Use this class to create, read, delete, or modify Service Level Agreement 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 SLA Definition list to the current isolated region.
VWSLADefinition	createSLADefinition(java.lang.String aSLAName) Creates a service level agreement (SLA) definition and adds it to a local list.
void	deleteSLADefinitions(java.lang.String[] theNames, java.lang.String theApplicationSpaceName) Deletes the specified service level agreement (SLA) definitions from the list and the isolated region.
VWSLADefinition	getSLADefinition(java.lang.String name) Gets the service level agreement (SLA) definition with the specified name from the list.
VWSLADefinition[]	getSLADefinitions() Gets all service level agreement (SLA) definitions in the list.
java.lang.String[]	getSLANames() Gets an array containing the names of the SLA definitions in the list.
java.lang.StringBuilder	importFromXML(java.io.BufferedReader in, int inputOption) Imports SLA 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

getSLADefinitions

public VWSLADefinition[] getSLADefinitions()
                                    throws VWException

Gets all service level agreement (SLA) 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 service level agreement (SLA) definition objects.

Throws:

VWException - Thrown for various reasons.

Since:

CPE 5.2.0.3

getSLADefinition

public VWSLADefinition getSLADefinition(java.lang.String name)
                                 throws VWException

Gets the service level agreement (SLA) definition with the specified name from the list.

Parameters:

name - The name of the service level agreement (SLA) definition.

Returns:

A VWSLADefinition object, if the service level agreement (SLA) definition is in the list.

Throws:

VWException - Thrown if the specified SLA definition is not found in the list.

Since:

CPE 5.2.0.3

deleteSLADefinitions

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

Deletes the specified service level agreement (SLA) definitions from the list and the isolated region.

Parameters:

theNames - The names of the service level agreement (SLA) 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 service level agreement (SLA) 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 an SLA definition cannot be deleted.

Since:

CPE 5.2.0.3

createSLADefinition

public VWSLADefinition createSLADefinition(java.lang.String aSLAName)
                                    throws VWException

Creates a service level agreement (SLA) definition and adds it to a local list.

Parameters:

aSLAName - A string containing the name to be used for the SLA definition.

Returns:

The new SLA definition.

Throws:

VWException - Thrown if the aSLAName parameter already exists in local list or if the system cannot create the SLA definition.

Since:

CPE 5.2.0.3

See Also:

VWSLADefinition

getSLANames

public java.lang.String[] getSLANames()

Gets an array containing the names of the SLA definitions in the list.

Returns:

The array of SLA 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 SLA Definition list to the current isolated region.

Before calling this method, SLA 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 service level agreement (SLA) 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 SLA definition objects from the specified BufferedReader object.

Parameters:

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

inputOption - One of the following:

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