wt.annotation
Class AnnotationSet

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

All Implemented Interfaces:

AccessControlled, AccessControlList, AdHocControlled, CabinetBased, CabinetMember, DisplayIdentification, DomainAdministered, Externalizable, FolderEntry, FolderServiceManaged, Indexable, LifeCycleManaged, NetFactor, Notifiable, ObjectMappable, Ownable, Persistable, RecentlyVisited, Serializable, TeamManaged, WTContained

Direct Known Subclasses:

StructuredAnnotationSet

public class AnnotationSet

extends CabinetManaged

implements WTContained, 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	APPLIED_BY Label for the attribute.
private static int	APPLIED_BY_UPPER_LIMIT
static String	APPLIED_DATE Label for the attribute.
private String	appliedBy
private Timestamp	appliedDate
private static String	CLASSNAME
static String	CONTAINER Label for the attribute.
private WTContainerRef	containerReference
private String	description
static String	DESCRIPTION Label for the attribute.
private static int	DESCRIPTION_UPPER_LIMIT
static long	EXTERNALIZATION_VERSION_UID
static String	IS_APPLIED Label for the attribute.
private boolean	isApplied
private String	name
static String	NAME Label for the attribute.
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
static long	R60_EXTERNALIZATION_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private XMLLob	theXMLLob
static String	XMLLOB Label for the attribute.

Fields inherited from class wt.enterprise.CabinetManaged

CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.lifecycle.LifeCycleManaged

LIFE_CYCLE_AT_GATE, LIFE_CYCLE_BASIC, LIFE_CYCLE_NAME, LIFE_CYCLE_STATE, LIFE_CYCLE_TEMPLATE, STATE

Fields inherited from interface wt.access.AdHocControlled

ENTRY_SET

Fields inherited from interface wt.team.TeamManaged

TEAM_ID, TEAM_IDENTITY, TEAM_NAME, TEAM_TEMPLATE_ID, TEAM_TEMPLATE_IDENTITY, TEAM_TEMPLATE_NAME

Fields inherited from interface wt.index.Indexable

INDEXER_SET

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.folder.CabinetMember

CABINET

Fields inherited from interface wt.folder.CabinetBased

CABINET_REFERENCE, FOLDER_PATH, LOCATION

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

AnnotationSet()

Method Summary

private void	appliedByValidate(String a_AppliedBy)
private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
private void	descriptionValidate(String a_Description)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getAppliedBy() Gets the value of the attribute: APPLIED_BY.
Timestamp	getAppliedDate() Gets the value of the attribute: APPLIED_DATE.
String	getConceptualClassname() Deprecated.
WTContainer	getContainer() Gets the object for the association that plays role: CONTAINER.
String	getContainerName() Gets the value of the attribute: CONTAINER_NAME.
WTContainerRef	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
String	getName() Gets the value of the attribute: NAME.
XMLLob	getXMLLob() Gets the object for the association that plays role: XMLLOB.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String name) Supports initialization, following construction of an instance.
boolean	isIsApplied() Gets the value of the attribute: IS_APPLIED.
private void	nameValidate(String a_Name)
static AnnotationSet	newAnnotationSet() Supported API: true
static AnnotationSet	newAnnotationSet(String name) Supported API: true
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(AnnotationSet thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAppliedBy(String a_AppliedBy) Sets the value of the attribute: APPLIED_BY.
void	setAppliedDate(Timestamp a_AppliedDate) Sets the value of the attribute: APPLIED_DATE.
void	setContainer(WTContainer a_Container) Sets the object for the association that plays role: CONTAINER.
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: CONTAINER_REFERENCE.
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.
void	setXMLLob(XMLLob a_XMLLob) Sets the object for the association that plays role: XMLLOB.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class wt.enterprise.CabinetManaged

getCabinet, getCabinetReference, getCreator, getCreatorEMail, getCreatorFullName, getCreatorName, getDomainRef, getEntrySet, getEventSet, getFolderPath, getIndexerSet, getLifeCycleName, getLifeCycleState, getLifeCycleTemplate, getLocation, getOwnership, getState, getTeamId, getTeamIdentity, getTeamName, getTeamTemplateId, getTeamTemplateIdentity, getTeamTemplateName, initialize, isInheritedDomain, isLifeCycleAtGate, isLifeCycleBasic, readVersion, setCabinet, setCreator, setDomainRef, setEntrySet, setEventSet, setIndexerSet, setInheritedDomain, setOwnership, setState, setTeamId, setTeamTemplateId

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

NAME

public static final String NAME

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

IS_APPLIED

public static final String IS_APPLIED

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

isApplied

private boolean isApplied

APPLIED_BY

public static final String APPLIED_BY

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

APPLIED_BY_UPPER_LIMIT

private static int APPLIED_BY_UPPER_LIMIT

appliedBy

private String appliedBy

APPLIED_DATE

public static final String APPLIED_DATE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

appliedDate

private Timestamp appliedDate

XMLLOB

public static final String XMLLOB

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

theXMLLob

private XMLLob theXMLLob

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerReference

private WTContainerRef containerReference

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

R60_EXTERNALIZATION_VERSION_UID

public static final long R60_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

AnnotationSet

public AnnotationSet()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class CabinetManaged

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class CabinetManaged

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(AnnotationSet thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class CabinetManaged

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class CabinetManaged

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: true

Specified by:

getName in interface CabinetBased

Overrides:

getName in class CabinetManaged

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

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

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

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

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

getAppliedBy

public String getAppliedBy()

Gets the value of the attribute: APPLIED_BY.

Supported API: false

Returns:

String

setAppliedBy

public void setAppliedBy(String a_AppliedBy)
                  throws WTPropertyVetoException

Sets the value of the attribute: APPLIED_BY.

Supported API: false

Parameters:

a_AppliedBy -

Throws:

WTPropertyVetoException

appliedByValidate

private void appliedByValidate(String a_AppliedBy)
                        throws WTPropertyVetoException

Parameters:

a_AppliedBy -

Throws:

WTPropertyVetoException

getAppliedDate

public Timestamp getAppliedDate()

Gets the value of the attribute: APPLIED_DATE.

Supported API: false

Returns:

Timestamp

setAppliedDate

public void setAppliedDate(Timestamp a_AppliedDate)
                    throws WTPropertyVetoException

Sets the value of the attribute: APPLIED_DATE.

Supported API: false

Parameters:

a_AppliedDate -

Throws:

WTPropertyVetoException

getXMLLob

public XMLLob getXMLLob()

Gets the object for the association that plays role: XMLLOB.

Supported API: false

Returns:

XMLLob

setXMLLob

public void setXMLLob(XMLLob a_XMLLob)
               throws WTPropertyVetoException

Sets the object for the association that plays role: XMLLOB.

Supported API: false

Parameters:

a_XMLLob -

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

getContainerName

public String getContainerName()

Gets the value of the attribute: CONTAINER_NAME. The name of the WTContainer this object is assigned to.

Supported API: false

Specified by:

getContainerName in interface WTContained

Returns:

String

getContainer

public WTContainer getContainer()

Gets the object for the association that plays role: CONTAINER.

Supported API: false

Specified by:

getContainer in interface WTContained

Returns:

WTContainer

setContainer

public void setContainer(WTContainer a_Container)
                  throws WTPropertyVetoException,
                         WTException

Sets the object for the association that plays role: CONTAINER.

Supported API: false

Specified by:

setContainer in interface WTContained

Parameters:

a_Container -

Throws:

WTPropertyVetoException

WTException

getContainerReference

public WTContainerRef getContainerReference()

Gets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

getContainerReference in interface WTContained

Returns:

WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

setContainerReference in interface WTContained

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class CabinetManaged

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class CabinetManaged

Returns:

int