wt.occurrence
Class UsesOccurrenceDocumentation

java.lang.Object
  wt.occurrence.UsesOccurrenceDocumentation

All Implemented Interfaces:

DocumentationOccurrenceData, Externalizable, NetFactor, ObjectMappable, OccurrenceData, Persistable, Serializable, UsesOccurrenceData

public final class UsesOccurrenceDocumentation

extends Object

implements DocumentationOccurrenceData, UsesOccurrenceData, Externalizable

This DocumentationOccurrenceData allows a UsesOccurrence to have an associated WTDocument version.

Use the newUsesOccurrenceDocumentation static factory method(s), not the UsesOccurrenceDocumentation 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	DOC Label for the attribute.
private ObjectReference	docReference
static long	EXTERNALIZATION_VERSION_UID
private DataOccurrenceReference	occReference
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private PersistInfo	thePersistInfo

Fields inherited from interface wt.occurrence.DocumentationOccurrenceData

DOC_REFERENCE

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.occurrence.UsesOccurrenceData

OCC_REFERENCE

Constructor Summary

UsesOccurrenceDocumentation()

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
private void	docReferenceValidate(ObjectReference a_DocReference)
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.
WTDocument	getDoc() Gets the object for the association that plays role: DOC.
ObjectReference	getDocReference() Gets the value of the attribute: DOC_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().
DataOccurrenceReference	getOccReference() Gets the object for the association that plays role: OCC_REFERENCE.
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().
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(UsesOccurrence occurrence, WTDocument document) Supports initialization, following construction of an instance.
static UsesOccurrenceDocumentation	newUsesOccurrenceDocumentation(UsesOccurrence occurrence, WTDocument document) Supported API: false
private void	occReferenceValidate(DataOccurrenceReference a_OccReference)
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(UsesOccurrenceDocumentation thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDoc(WTDocument a_Doc) Sets the object for the association that plays role: DOC.
void	setDocReference(ObjectReference a_DocReference) Sets the value of the attribute: DOC_REFERENCE.
void	setOccReference(DataOccurrenceReference a_OccReference) Sets the object for the association that plays role: OCC_REFERENCE.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
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

DOC

public static final String DOC

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

docReference

private ObjectReference docReference

thePersistInfo

private PersistInfo thePersistInfo

occReference

private DataOccurrenceReference occReference

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

UsesOccurrenceDocumentation

public UsesOccurrenceDocumentation()

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(UsesOccurrenceDocumentation 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

newUsesOccurrenceDocumentation

public static UsesOccurrenceDocumentation newUsesOccurrenceDocumentation(UsesOccurrence occurrence,
                                                                         WTDocument document)
                                                                  throws WTException

Supported API: false

Parameters:

occurrence -

document -

Returns:

UsesOccurrenceDocumentation

Throws:

WTException

initialize

protected void initialize(UsesOccurrence occurrence,
                          WTDocument document)
                   throws WTException

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

Supported API: false

Parameters:

occurrence -

document -

Throws:

WTException

getDoc

public WTDocument getDoc()

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

Supported API: false

Specified by:

getDoc in interface DocumentationOccurrenceData

Returns:

WTDocument

setDoc

public void setDoc(WTDocument a_Doc)
            throws WTPropertyVetoException,
                   WTException

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

Supported API: false

Specified by:

setDoc in interface DocumentationOccurrenceData

Parameters:

a_Doc -

Throws:

WTPropertyVetoException

WTException

getDocReference

public ObjectReference getDocReference()

Gets the value of the attribute: DOC_REFERENCE.

Supported API: false

Specified by:

getDocReference in interface DocumentationOccurrenceData

Returns:

ObjectReference

setDocReference

public void setDocReference(ObjectReference a_DocReference)
                     throws WTPropertyVetoException

Sets the value of the attribute: DOC_REFERENCE.

Supported API: false

Specified by:

setDocReference in interface DocumentationOccurrenceData

Parameters:

a_DocReference -

Throws:

WTPropertyVetoException

docReferenceValidate

private void docReferenceValidate(ObjectReference a_DocReference)
                           throws WTPropertyVetoException

Parameters:

a_DocReference -

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 -

getOccReference

public DataOccurrenceReference getOccReference()

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

Supported API: false

Specified by:

getOccReference in interface UsesOccurrenceData

Returns:

DataOccurrenceReference

setOccReference

public void setOccReference(DataOccurrenceReference a_OccReference)
                     throws WTPropertyVetoException

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

Supported API: false

Specified by:

setOccReference in interface UsesOccurrenceData

Parameters:

a_OccReference -

Throws:

WTPropertyVetoException

occReferenceValidate

private void occReferenceValidate(DataOccurrenceReference a_OccReference)
                           throws WTPropertyVetoException

Parameters:

a_OccReference -

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

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