wt.annotation
Class StructuredAnnotationSet

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

All Implemented Interfaces:

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

public class StructuredAnnotationSet

extends AnnotationSet

implements Externalizable

Use the newStructuredAnnotationSet static factory method(s), not the StructuredAnnotationSet 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	BASELINE Label for the attribute.
static String	BASELINE_REFERENCE Label for the attribute.
private ObjectReference	baselineReference
private static String	CLASSNAME
static String	CONFIGSPEC Label for the attribute.
static String	CONFIGSPEC_REFERENCE Label for the attribute.
private ObjectReference	configspecReference
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	TARGET Label for the attribute.
static String	TARGET_REFERENCE Label for the attribute.
private ObjectReference	targetReference

Fields inherited from class wt.annotation.AnnotationSet

APPLIED_BY, APPLIED_DATE, CONTAINER, DESCRIPTION, IS_APPLIED, NAME, R60_EXTERNALIZATION_VERSION_UID, XMLLOB

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

StructuredAnnotationSet()

Method Summary

private void	baselineReferenceValidate(ObjectReference a_BaselineReference)
private void	configspecReferenceValidate(ObjectReference a_ConfigspecReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
AnnotationBaseline	getBaseline() Gets the object for the association that plays role: BASELINE.
ObjectReference	getBaselineReference() Gets the value of the attribute: BASELINE_REFERENCE.
String	getConceptualClassname() Deprecated.
WTPartConfigSpec	getConfigspec() Gets the object for the association that plays role: CONFIGSPEC.
ObjectReference	getConfigspecReference() Gets the value of the attribute: CONFIGSPEC_REFERENCE.
AnnotationTarget	getTarget() Gets the object for the association that plays role: TARGET.
ObjectReference	getTargetReference() Gets the value of the attribute: TARGET_REFERENCE.
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.
static StructuredAnnotationSet	newStructuredAnnotationSet() Supported API: true
static StructuredAnnotationSet	newStructuredAnnotationSet(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(StructuredAnnotationSet thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setBaseline(AnnotationBaseline a_Baseline) Sets the object for the association that plays role: BASELINE.
void	setBaselineReference(ObjectReference a_BaselineReference) Sets the value of the attribute: BASELINE_REFERENCE.
void	setConfigspec(WTPartConfigSpec a_Configspec) Sets the object for the association that plays role: CONFIGSPEC.
void	setConfigspecReference(ObjectReference a_ConfigspecReference) Sets the value of the attribute: CONFIGSPEC_REFERENCE.
void	setTarget(AnnotationTarget a_Target) Sets the object for the association that plays role: TARGET.
void	setTargetReference(ObjectReference a_TargetReference) Sets the value of the attribute: TARGET_REFERENCE.
private void	targetReferenceValidate(ObjectReference a_TargetReference)
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.annotation.AnnotationSet

getAppliedBy, getAppliedDate, getContainer, getContainerName, getContainerReference, getDescription, getName, getXMLLob, isIsApplied, newAnnotationSet, newAnnotationSet, readVersion, setAppliedBy, setAppliedDate, setContainer, setContainerReference, setDescription, setIsApplied, setName, setXMLLob

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

TARGET

public static final String TARGET

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

TARGET_REFERENCE

public static final String TARGET_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

targetReference

private ObjectReference targetReference

BASELINE

public static final String BASELINE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

BASELINE_REFERENCE

public static final String BASELINE_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

baselineReference

private ObjectReference baselineReference

CONFIGSPEC

public static final String CONFIGSPEC

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CONFIGSPEC_REFERENCE

public static final String CONFIGSPEC_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

configspecReference

private ObjectReference configspecReference

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

Constructor Detail

StructuredAnnotationSet

public StructuredAnnotationSet()

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 AnnotationSet

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 AnnotationSet

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(StructuredAnnotationSet 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 AnnotationSet

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 AnnotationSet

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

Overrides:

getConceptualClassname in class AnnotationSet

Returns:

String

getTarget

public AnnotationTarget getTarget()

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

Supported API: false

Returns:

AnnotationTarget

setTarget

public void setTarget(AnnotationTarget a_Target)
               throws WTPropertyVetoException,
                      WTException

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

Supported API: false

Parameters:

a_Target -

Throws:

WTPropertyVetoException

WTException

getTargetReference

public ObjectReference getTargetReference()

Gets the value of the attribute: TARGET_REFERENCE.

Supported API: false

Returns:

ObjectReference

setTargetReference

public void setTargetReference(ObjectReference a_TargetReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: TARGET_REFERENCE.

Supported API: false

Parameters:

a_TargetReference -

Throws:

WTPropertyVetoException

targetReferenceValidate

private void targetReferenceValidate(ObjectReference a_TargetReference)
                              throws WTPropertyVetoException

Parameters:

a_TargetReference -

Throws:

WTPropertyVetoException

getBaseline

public AnnotationBaseline getBaseline()

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

Supported API: false

Returns:

AnnotationBaseline

setBaseline

public void setBaseline(AnnotationBaseline a_Baseline)
                 throws WTPropertyVetoException,
                        WTException

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

Supported API: false

Parameters:

a_Baseline -

Throws:

WTPropertyVetoException

WTException

getBaselineReference

public ObjectReference getBaselineReference()

Gets the value of the attribute: BASELINE_REFERENCE.

Supported API: false

Returns:

ObjectReference

setBaselineReference

public void setBaselineReference(ObjectReference a_BaselineReference)
                          throws WTPropertyVetoException

Sets the value of the attribute: BASELINE_REFERENCE.

Supported API: false

Parameters:

a_BaselineReference -

Throws:

WTPropertyVetoException

baselineReferenceValidate

private void baselineReferenceValidate(ObjectReference a_BaselineReference)
                                throws WTPropertyVetoException

Parameters:

a_BaselineReference -

Throws:

WTPropertyVetoException

getConfigspec

public WTPartConfigSpec getConfigspec()

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

Supported API: false

Returns:

WTPartConfigSpec

setConfigspec

public void setConfigspec(WTPartConfigSpec a_Configspec)
                   throws WTPropertyVetoException,
                          WTException

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

Supported API: false

Parameters:

a_Configspec -

Throws:

WTPropertyVetoException

WTException

getConfigspecReference

public ObjectReference getConfigspecReference()

Gets the value of the attribute: CONFIGSPEC_REFERENCE.

Supported API: false

Returns:

ObjectReference

setConfigspecReference

public void setConfigspecReference(ObjectReference a_ConfigspecReference)
                            throws WTPropertyVetoException

Sets the value of the attribute: CONFIGSPEC_REFERENCE.

Supported API: false

Parameters:

a_ConfigspecReference -

Throws:

WTPropertyVetoException

configspecReferenceValidate

private void configspecReferenceValidate(ObjectReference a_ConfigspecReference)
                                  throws WTPropertyVetoException

Parameters:

a_ConfigspecReference -

Throws:

WTPropertyVetoException

newStructuredAnnotationSet

public static StructuredAnnotationSet newStructuredAnnotationSet()
                                                          throws WTException

Supported API: true

Returns:

StructuredAnnotationSet

Throws:

WTException

newStructuredAnnotationSet

public static StructuredAnnotationSet newStructuredAnnotationSet(String name)
                                                          throws WTException

Supported API: true

Parameters:

name -

Returns:

StructuredAnnotationSet

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

Overrides:

initialize in class AnnotationSet

Parameters:

name -

Throws:

WTException

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 AnnotationSet

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 AnnotationSet

Returns:

int