wt.epm.structure.occurrences
Class EPMUsesOccurrence

java.lang.Object
  wt.epm.structure.occurrences.EPMUsesOccurrence

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Occurrence, Persistable, Serializable, UsesOccurrence

public class EPMUsesOccurrence

extends Object

implements UsesOccurrence, Externalizable

Use the newEPMUsesOccurrence static factory method(s), not the EPMUsesOccurrence 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: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static String	CONTEXT Label for the attribute.
private ObjectReference	contextReference
static long	EXTERNALIZATION_VERSION_UID
static String	LINK Label for the attribute.
private ObjectReference	linkReference
private String	name
private static int	NAME_UPPER_LIMIT
private Vector	occurrenceDataVector
protected static long	OLD_FORMAT_VERSION_UID
private PathOccurrence	pathOccurrence
private static String	RESOURCE
(package private) static long	serialVersionUID
private PersistInfo	thePersistInfo
private long	usesOccurrenceDataIdentifier
private long	usesOccurrenceIdentifier

Fields inherited from interface wt.occurrence.UsesOccurrence

CONTEXT_REFERENCE, LINK_REFERENCE, PATH_OCCURRENCE, USES_NAME, USES_OCCURRENCE_DATA_IDENTIFIER, USES_OCCURRENCE_IDENTIFIER

Fields inherited from interface wt.occurrence.Occurrence

NAME, OCCURRENCE_DATA_VECTOR

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

EPMUsesOccurrence()

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
private void	contextReferenceValidate(ObjectReference a_ContextReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
UsesOccurrenceContext	getContext() Gets the object for the association that plays role: CONTEXT.
ObjectReference	getContextReference() Gets the value of the attribute: CONTEXT_REFERENCE.
String	getIdentity() Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().
OccurrenceableLink	getLink() Gets the object for the association that plays role: LINK.
ObjectReference	getLinkReference() Gets the value of the attribute: LINK_REFERENCE.
String	getName() Gets the value of the attribute: NAME.
Vector	getOccurrenceDataVector() Gets the value of the attribute: OCCURRENCE_DATA_VECTOR.
PathOccurrence	getPathOccurrence() Gets the value of the attribute: PATH_OCCURRENCE.
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
String	getType() Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().
String	getUsesName() Gets the value of the attribute: USES_NAME.
long	getUsesOccurrenceDataIdentifier() Gets the value of the attribute: USES_OCCURRENCE_DATA_IDENTIFIER.
long	getUsesOccurrenceIdentifier() Gets the value of the attribute: USES_OCCURRENCE_IDENTIFIER.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(EPMUsesOccurrence original) Supports initialization, following construction of an instance.
protected void	initialize(OccurrenceableLink occurrenceableLink) Supports initialization, following construction of an instance.
boolean	isPlaceholder() Returns true if the UsesOccurrence is only used to complete a PathOccurrence and has no other useful information associated with it.
private void	linkReferenceValidate(ObjectReference a_LinkReference)
private void	nameValidate(String a_Name)
static EPMUsesOccurrence	newEPMUsesOccurrence(EPMUsesOccurrence original) This constructor returns a copy of the EPMUsesOccurrence passed to it.
static EPMUsesOccurrence	newEPMUsesOccurrence(OccurrenceableLink occurrenceableLink) This constructor returns a EPMUsesOccurrence associated to the given OccurrenceableLink.
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(EPMUsesOccurrence thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setContext(UsesOccurrenceContext a_Context) Sets the object for the association that plays role: CONTEXT.
void	setContextReference(ObjectReference a_ContextReference) Sets the value of the attribute: CONTEXT_REFERENCE.
void	setLink(OccurrenceableLink a_Link) Sets the object for the association that plays role: LINK.
void	setLinkReference(ObjectReference a_LinkReference) Sets the value of the attribute: LINK_REFERENCE.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setOccurrenceDataVector(Vector a_OccurrenceDataVector) Sets the value of the attribute: OCCURRENCE_DATA_VECTOR.
void	setPathOccurrence(PathOccurrence a_PathOccurrence) Sets the value of the attribute: PATH_OCCURRENCE.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
void	setUsesName(String a_UsesName) Sets the value of the attribute: USES_NAME.
void	setUsesOccurrenceDataIdentifier(long a_UsesOccurrenceDataIdentifier) Sets the value of the attribute: USES_OCCURRENCE_DATA_IDENTIFIER.
void	setUsesOccurrenceIdentifier(long a_UsesOccurrenceIdentifier) Sets the value of the attribute: USES_OCCURRENCE_IDENTIFIER.
String	toString() Returns the conceptual (modeled) name for the class.
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 java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

usesOccurrenceDataIdentifier

private long usesOccurrenceDataIdentifier

usesOccurrenceIdentifier

private long usesOccurrenceIdentifier

pathOccurrence

private PathOccurrence pathOccurrence

LINK

public static final String LINK

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

linkReference

private ObjectReference linkReference

CONTEXT

public static final String CONTEXT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

contextReference

private ObjectReference contextReference

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

occurrenceDataVector

private Vector occurrenceDataVector

thePersistInfo

private PersistInfo thePersistInfo

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

EPMUsesOccurrence

public EPMUsesOccurrence()

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

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

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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

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

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

newEPMUsesOccurrence

public static EPMUsesOccurrence newEPMUsesOccurrence(EPMUsesOccurrence original)
                                              throws WTException

This constructor returns a copy of the EPMUsesOccurrence passed to it.

Supported API: false

Parameters:

original -

Returns:

EPMUsesOccurrence

Throws:

WTException

initialize

protected void initialize(EPMUsesOccurrence original)
                   throws WTException

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

Supported API: false

Parameters:

original -

Throws:

WTException

newEPMUsesOccurrence

public static EPMUsesOccurrence newEPMUsesOccurrence(OccurrenceableLink occurrenceableLink)
                                              throws WTException

This constructor returns a EPMUsesOccurrence associated to the given OccurrenceableLink.

Supported API: false

Parameters:

occurrenceableLink -

Returns:

EPMUsesOccurrence

Throws:

WTException

initialize

protected void initialize(OccurrenceableLink occurrenceableLink)
                   throws WTException

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

Supported API: false

Parameters:

occurrenceableLink -

Throws:

WTException

getUsesOccurrenceDataIdentifier

public long getUsesOccurrenceDataIdentifier()

Gets the value of the attribute: USES_OCCURRENCE_DATA_IDENTIFIER. This identifier is used to improve efficiency so that many UsesOccurrenceData objects can have the same foreign key link to this UsesOccurrence and several UsesOccurrence objects can also share this same identifier, but only if all of their associated UsesOccurrenceData objects are the same. If several UsesOccurrences share the same UsesOccurrenceData objects and one wants to change it (without affecting the others), then it must get a new identifier for itself and make copies of all of its OccurrenceData objects and link to those new copies by putting its new identifier into them as a foreign key. Finally it can change this new set of data as desired without affecting other UsesOccurrences. Because of the complex management of this attribute it is necessary to call one of the OccurrenceService#saveUsesOccurrenceAndData methods when saving a UsesOccurrence (and optionally its associated UsesOccurenceData.

Supported API: false

Specified by:

getUsesOccurrenceDataIdentifier in interface UsesOccurrence

Returns:

long

setUsesOccurrenceDataIdentifier

public void setUsesOccurrenceDataIdentifier(long a_UsesOccurrenceDataIdentifier)
                                     throws WTPropertyVetoException

Sets the value of the attribute: USES_OCCURRENCE_DATA_IDENTIFIER. This identifier is used to improve efficiency so that many UsesOccurrenceData objects can have the same foreign key link to this UsesOccurrence and several UsesOccurrence objects can also share this same identifier, but only if all of their associated UsesOccurrenceData objects are the same. If several UsesOccurrences share the same UsesOccurrenceData objects and one wants to change it (without affecting the others), then it must get a new identifier for itself and make copies of all of its OccurrenceData objects and link to those new copies by putting its new identifier into them as a foreign key. Finally it can change this new set of data as desired without affecting other UsesOccurrences. Because of the complex management of this attribute it is necessary to call one of the OccurrenceService#saveUsesOccurrenceAndData methods when saving a UsesOccurrence (and optionally its associated UsesOccurenceData.

Supported API: false

Specified by:

setUsesOccurrenceDataIdentifier in interface UsesOccurrence

Parameters:

a_UsesOccurrenceDataIdentifier -

Throws:

WTPropertyVetoException

getUsesOccurrenceIdentifier

public long getUsesOccurrenceIdentifier()

Gets the value of the attribute: USES_OCCURRENCE_IDENTIFIER. This identifier is shared by many OccurrenceableLink objects, all of which represent the same link, except maybe for different iterations or versions of objects being linked. In other words, when the OccurrenceableLink is copied forward this identifier is copied without changing its value.

Supported API: true

Specified by:

getUsesOccurrenceIdentifier in interface UsesOccurrence

Returns:

long

setUsesOccurrenceIdentifier

public void setUsesOccurrenceIdentifier(long a_UsesOccurrenceIdentifier)
                                 throws WTPropertyVetoException

Sets the value of the attribute: USES_OCCURRENCE_IDENTIFIER. This identifier is shared by many OccurrenceableLink objects, all of which represent the same link, except maybe for different iterations or versions of objects being linked. In other words, when the OccurrenceableLink is copied forward this identifier is copied without changing its value.

Supported API: true

Specified by:

setUsesOccurrenceIdentifier in interface UsesOccurrence

Parameters:

a_UsesOccurrenceIdentifier -

Throws:

WTPropertyVetoException

getPathOccurrence

public PathOccurrence getPathOccurrence()

Gets the value of the attribute: PATH_OCCURRENCE. This non-persistent PathOccurrence can be populated to hold the value that applies in a particular situation.

Supported API: false

Specified by:

getPathOccurrence in interface UsesOccurrence

Returns:

PathOccurrence

setPathOccurrence

public void setPathOccurrence(PathOccurrence a_PathOccurrence)

Sets the value of the attribute: PATH_OCCURRENCE. This non-persistent PathOccurrence can be populated to hold the value that applies in a particular situation.

Supported API: false

Specified by:

setPathOccurrence in interface UsesOccurrence

Parameters:

a_PathOccurrence -

getUsesName

public String getUsesName()

Gets the value of the attribute: USES_NAME. This alias for the name attribute is useful in some cases by introspection so that the name of a UsesOccurrence is distinct from the name of other Occurrences.

Supported API: true

Specified by:

getUsesName in interface UsesOccurrence

Returns:

String

setUsesName

public void setUsesName(String a_UsesName)
                 throws WTPropertyVetoException

Sets the value of the attribute: USES_NAME. This alias for the name attribute is useful in some cases by introspection so that the name of a UsesOccurrence is distinct from the name of other Occurrences.

Supported API: true

Specified by:

setUsesName in interface UsesOccurrence

Parameters:

a_UsesName -

Throws:

WTPropertyVetoException

isPlaceholder

public boolean isPlaceholder()

Returns true if the UsesOccurrence is only used to complete a PathOccurrence and has no other useful information associated with it.

Supported API: true

Specified by:

isPlaceholder in interface UsesOccurrence

Returns:

boolean

getLink

public OccurrenceableLink getLink()

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

Supported API: false

Specified by:

getLink in interface UsesOccurrence

Returns:

OccurrenceableLink

setLink

public void setLink(OccurrenceableLink a_Link)
             throws WTPropertyVetoException,
                    WTException

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

Supported API: false

Specified by:

setLink in interface UsesOccurrence

Parameters:

a_Link -

Throws:

WTPropertyVetoException

WTException

getLinkReference

public ObjectReference getLinkReference()

Gets the value of the attribute: LINK_REFERENCE.

Supported API: false

Specified by:

getLinkReference in interface UsesOccurrence

Returns:

ObjectReference

setLinkReference

public void setLinkReference(ObjectReference a_LinkReference)
                      throws WTPropertyVetoException

Sets the value of the attribute: LINK_REFERENCE.

Supported API: false

Specified by:

setLinkReference in interface UsesOccurrence

Parameters:

a_LinkReference -

Throws:

WTPropertyVetoException

linkReferenceValidate

private void linkReferenceValidate(ObjectReference a_LinkReference)
                            throws WTPropertyVetoException

Parameters:

a_LinkReference -

Throws:

WTPropertyVetoException

getContext

public UsesOccurrenceContext getContext()

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

Supported API: false

Specified by:

getContext in interface UsesOccurrence

Returns:

UsesOccurrenceContext

setContext

public void setContext(UsesOccurrenceContext a_Context)
                throws WTPropertyVetoException,
                       WTException

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

Supported API: false

Specified by:

setContext in interface UsesOccurrence

Parameters:

a_Context -

Throws:

WTPropertyVetoException

WTException

getContextReference

public ObjectReference getContextReference()

Gets the value of the attribute: CONTEXT_REFERENCE.

Supported API: false

Specified by:

getContextReference in interface UsesOccurrence

Returns:

ObjectReference

setContextReference

public void setContextReference(ObjectReference a_ContextReference)
                         throws WTPropertyVetoException

Sets the value of the attribute: CONTEXT_REFERENCE.

Supported API: false

Specified by:

setContextReference in interface UsesOccurrence

Parameters:

a_ContextReference -

Throws:

WTPropertyVetoException

contextReferenceValidate

private void contextReferenceValidate(ObjectReference a_ContextReference)
                               throws WTPropertyVetoException

Parameters:

a_ContextReference -

Throws:

WTPropertyVetoException

getName

public String getName()

Gets the value of the attribute: NAME. The name of an Occurrence is often referred to as a Reference Designator.

Supported API: true

Specified by:

getName in interface Occurrence

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. The name of an Occurrence is often referred to as a Reference Designator.

Supported API: true

Specified by:

setName in interface Occurrence

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getOccurrenceDataVector

public Vector getOccurrenceDataVector()

Gets the value of the attribute: OCCURRENCE_DATA_VECTOR. This Vector can be populated with OccurrenceData that is associated to an Occurrence.

Supported API: true

Specified by:

getOccurrenceDataVector in interface Occurrence

Returns:

Vector

setOccurrenceDataVector

public void setOccurrenceDataVector(Vector a_OccurrenceDataVector)
                             throws WTPropertyVetoException

Sets the value of the attribute: OCCURRENCE_DATA_VECTOR. This Vector can be populated with OccurrenceData that is associated to an Occurrence.

Supported API: true

Specified by:

setOccurrenceDataVector in interface Occurrence

Parameters:

a_OccurrenceDataVector -

Throws:

WTPropertyVetoException

getIdentity

public String getIdentity()

Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().

Gets the value of the attribute: IDENTITY. Supplies the identity of the object for business purposes. The identity is composed of name, number or possibly other attributes. The identity does not include the type of the object.

Supported API: false

Specified by:

getIdentity in interface Persistable

Returns:

String

getType

public String getType()

Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().

Gets the value of the attribute: TYPE. Identifies the type of the object for business purposes. This is typically the class name of the object but may be derived from some other attribute of the object.

Supported API: false

Specified by:

getType in interface Persistable

Returns:

String

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:

checkAttributes in interface Persistable

Throws:

InvalidAttributeException

getPersistInfo

public PersistInfo getPersistInfo()

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

Supported API: false

Specified by:

getPersistInfo in interface Persistable

Returns:

PersistInfo

setPersistInfo

public void setPersistInfo(PersistInfo a_PersistInfo)

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

Supported API: false

Specified by:

setPersistInfo in interface Persistable

Parameters:

a_PersistInfo -

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

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

Returns:

int