wt.annotation
Class AnnotationSet

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.CabinetManaged
          wt.annotation.AnnotationSet

All Implemented Interfaces:

Externalizable, Serializable, AccessControlled, wt.access.AccessControlList, wt.access.AdHocControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, wt.change2.SupportingMaterial, NetFactor, ObjectMappable, Persistable, CabinetBased, CabinetMember, FolderEntry, wt.folder.FolderServiceManaged, DisplayIdentification, Indexable, WTContained, wt.lifecycle.LifeCycleManaged, Notifiable, Ownable, wt.recent.RecentlyVisited, wt.team.TeamManaged

Direct Known Subclasses:

StructuredAnnotationSet

public class AnnotationSet
extends CabinetManaged
implements WTContained, wt.change2.SupportingMaterial, Externalizable

Use the newAnnotationSet static factory method(s), not the AnnotationSet constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: true

See Also:

Serialized Form

Field Summary

static String	DESCRIPTION Label for the attribute.
static String	IS_APPLIED Label for the attribute.
static String	NAME Label for the attribute.

Method Summary

String	getDescription() Gets the value of the attribute: DESCRIPTION.
String	getName() Gets the value of the attribute: NAME.
protected void	initialize(String name) Supports initialization, following construction of an instance.
boolean	isIsApplied() Gets the value of the attribute: IS_APPLIED.
static AnnotationSet	newAnnotationSet() Supported API: true
static AnnotationSet	newAnnotationSet(String name) Supported API: true
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setIsApplied(boolean a_IsApplied) Sets the value of the attribute: IS_APPLIED.
void	setName(String a_Name) Sets the value of the attribute: NAME.

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NAME

public static final String NAME

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

IS_APPLIED

public static final String IS_APPLIED

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: true

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME.

Supported API: true

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION.

Supported API: true

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION.

Supported API: true

Parameters:

a_Description -

Throws:

WTPropertyVetoException

isIsApplied

public boolean isIsApplied()

Gets the value of the attribute: IS_APPLIED.

Supported API: true

Returns:

boolean

setIsApplied

public void setIsApplied(boolean a_IsApplied)
                  throws WTPropertyVetoException

Sets the value of the attribute: IS_APPLIED.

Supported API: true

Parameters:

a_IsApplied -

Throws:

WTPropertyVetoException

newAnnotationSet

public static AnnotationSet newAnnotationSet()
                                      throws WTException

Supported API: true

Returns:

AnnotationSet

Throws:

WTException

newAnnotationSet

public static AnnotationSet newAnnotationSet(String name)
                                      throws WTException

Supported API: true

Parameters:

name -

Returns:

AnnotationSet

Throws:

WTException

initialize

protected void initialize(String name)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

name -

Throws:

WTException