filenet.vw.api

Class VWSLADefinition

java.lang.Object

filenet.vw.api.VWSLADefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public final class VWSLADefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Use this class to create, read, delete, or modify Service Level Agreement definition properties.

Since:

CPE 5.2.0.3

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
VWSLAEntryDefinition	createSLAEntryDefinition() Creates a new SLA Entry definition.
java.lang.String	getAuthoredName() Gets the authored name assigned to Service Level Agreement (SLA) definition.
java.lang.String	getDescription() Gets the description of the SLA definition.
java.lang.String	getName() Gets the name assigned to the Service Level Agreement (SLA) definition.
VWSLAEntryDefinition[]	getSLAEntryDefinitions() Get the SLA Entry definitions defined for the SLA definition.
void	setDescription(java.lang.String description) Sets the description of the SLA definition.
void	setSLAEntryDefinitions(VWSLAEntryDefinition[] theSLAEntryDefinitions) Sets the SLA entry definitions for this SLA definition.
java.lang.String	toString() Gets the name of the SLA definition.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()
                         throws VWException

Gets the name assigned to the Service Level Agreement (SLA) definition. If a translated version exists, that version is returned.

Returns:

A String containing the name of the Service Level Agreement (SLA) definition.

Throws:

VWException - thrown for various reasons.

Since:

CPE 5.2.0.3

getAuthoredName

public java.lang.String getAuthoredName()
                                 throws VWException

Gets the authored name assigned to Service Level Agreement (SLA) definition.

Returns:

A String containing the authored name of the Service Level Agreement (SLA) definition.

Throws:

VWException

Since:

CPE 5.2.0.3

getDescription

public java.lang.String getDescription()
                                throws VWException

Gets the description of the SLA definition.

Returns:

A String containing the description.

Throws:

VWException - Thrown for various reasons.

Since:

CPE 5.2.0.3

setDescription

public void setDescription(java.lang.String description)
                    throws VWException

Sets the description of the SLA definition.

Parameters:

description - A String containing the description.

Throws:

VWException - Thrown for various reasons.

Since:

CPE 5.2.0.3

getSLAEntryDefinitions

public VWSLAEntryDefinition[] getSLAEntryDefinitions()
                                              throws VWException

Get the SLA Entry definitions defined for the SLA definition.

Returns:

An array of VWSLAEntryDefinition objects defined for this SLA definition.

Throws:

VWException

Since:

CPE 5.2.0.3

createSLAEntryDefinition

public VWSLAEntryDefinition createSLAEntryDefinition()
                                              throws VWException

Creates a new SLA Entry definition.

Returns:

The new SLA Entry definition.

Throws:

VWException - Thrown for various reasons

Since:

CPE 5.2.0.3

setSLAEntryDefinitions

public void setSLAEntryDefinitions(VWSLAEntryDefinition[] theSLAEntryDefinitions)
                            throws VWException

Sets the SLA entry definitions for this SLA definition.

Parameters:

theSLAEntryDefinitions - An array of VWSLAEntryDefinition objects that are to be used by this SLA definition. The array must contain at least 1 element.

Throws:

VWException - Thrown if a null or empty list of SLA Entry definitions is specified.

Since:

CPE 5.2.0.3

toString

public java.lang.String toString()

Gets the name of the SLA definition.

Overrides:

toString in class java.lang.Object

Returns:

A String containing the name of the SLA definition.

Since:

CPE 5.2.0.3