wt.csm.ranking
Class RankingData

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.csm.ranking.RankingData

All Implemented Interfaces:

AccessControlled, BusinessInformation, DisplayIdentification, DomainAdministered, Externalizable, IBAReferenceable, NetFactor, Notifiable, ObjectMappable, Persistable, Serializable

public class RankingData

extends Simple

implements IBAReferenceable, Externalizable

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

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static String	CONTEXT Label for the attribute.
static String	CONTEXT_REFERENCE Label for the attribute.
private ObjectReference	contextReference
private DeepCloneable	data
static String	DATA Label for the attribute.
private static boolean	debug
static long	EXTERNALIZATION_VERSION_UID
static String	NODE Label for the attribute.
static String	NODE_REFERENCE Label for the attribute.
private ObjectReference	nodeReference
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

RankingData()

Method Summary

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.
String	getConceptualClassname() Deprecated.
RankingContext	getContext() Gets the object for the association that plays role: CONTEXT.
ObjectReference	getContextReference() Gets the value of the attribute: CONTEXT_REFERENCE.
DeepCloneable	getData() Gets the value of the attribute: DATA.
String	getIBAReferenceableDisplayString() Supported API: false
ClassificationNode	getNode() Gets the object for the association that plays role: NODE.
ObjectReference	getNodeReference() Gets the value of the attribute: NODE_REFERENCE.
String	getReferenceID() Supported API: false
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(RankingContext context, ClassificationNode node) Supports initialization, following construction of an instance.
static RankingData	newRankingData(RankingContext context, ClassificationNode node) Supported API: false
private void	nodeReferenceValidate(ObjectReference a_NodeReference)
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(RankingData thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setContext(RankingContext 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	setData(DeepCloneable a_Data) Sets the value of the attribute: DATA.
void	setNode(ClassificationNode a_Node) Sets the object for the association that plays role: NODE.
void	setNodeReference(ObjectReference a_NodeReference) Sets the value of the attribute: NODE_REFERENCE.
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.Simple

getBusinessType, getDomainRef, getEventSet, getIdentity, initialize, isInheritedDomain, readVersion, setDomainRef, setEventSet, setInheritedDomain

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, 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

DATA

public static final String DATA

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

data

private DeepCloneable data

NODE

public static final String NODE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

NODE_REFERENCE

public static final String NODE_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

nodeReference

private ObjectReference nodeReference

CONTEXT

public static final String CONTEXT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CONTEXT_REFERENCE

public static final String CONTEXT_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

contextReference

private ObjectReference contextReference

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

debug

private static final boolean debug

Constructor Detail

RankingData

public RankingData()

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 Simple

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 Simple

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 Simple

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

getData

public DeepCloneable getData()

Gets the value of the attribute: DATA.

Supported API: false

Returns:

DeepCloneable

setData

public void setData(DeepCloneable a_Data)
             throws WTPropertyVetoException

Sets the value of the attribute: DATA.

Supported API: false

Parameters:

a_Data -

Throws:

WTPropertyVetoException

getNode

public ClassificationNode getNode()

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

Supported API: false

Returns:

ClassificationNode

setNode

public void setNode(ClassificationNode a_Node)
             throws WTPropertyVetoException,
                    WTException

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

Supported API: false

Parameters:

a_Node -

Throws:

WTPropertyVetoException

WTException

getNodeReference

public ObjectReference getNodeReference()

Gets the value of the attribute: NODE_REFERENCE.

Supported API: false

Returns:

ObjectReference

setNodeReference

public void setNodeReference(ObjectReference a_NodeReference)
                      throws WTPropertyVetoException

Sets the value of the attribute: NODE_REFERENCE.

Supported API: false

Parameters:

a_NodeReference -

Throws:

WTPropertyVetoException

nodeReferenceValidate

private void nodeReferenceValidate(ObjectReference a_NodeReference)
                            throws WTPropertyVetoException

Parameters:

a_NodeReference -

Throws:

WTPropertyVetoException

getContext

public RankingContext getContext()

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

Supported API: false

Returns:

RankingContext

setContext

public void setContext(RankingContext a_Context)
                throws WTPropertyVetoException,
                       WTException

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

Supported API: false

Parameters:

a_Context -

Throws:

WTPropertyVetoException

WTException

getContextReference

public ObjectReference getContextReference()

Gets the value of the attribute: CONTEXT_REFERENCE.

Supported API: false

Returns:

ObjectReference

setContextReference

public void setContextReference(ObjectReference a_ContextReference)
                         throws WTPropertyVetoException

Sets the value of the attribute: CONTEXT_REFERENCE.

Supported API: false

Parameters:

a_ContextReference -

Throws:

WTPropertyVetoException

contextReferenceValidate

private void contextReferenceValidate(ObjectReference a_ContextReference)
                               throws WTPropertyVetoException

Parameters:

a_ContextReference -

Throws:

WTPropertyVetoException

newRankingData

public static RankingData newRankingData(RankingContext context,
                                         ClassificationNode node)
                                  throws WTException

Supported API: false

Parameters:

context -

node -

Returns:

RankingData

Throws:

WTException

initialize

protected void initialize(RankingContext context,
                          ClassificationNode node)
                   throws WTException

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

Supported API: false

Parameters:

context -

node -

Throws:

WTException

getIBAReferenceableDisplayString

public String getIBAReferenceableDisplayString()

Supported API: false

Specified by:

getIBAReferenceableDisplayString in interface IBAReferenceable

Returns:

String

getReferenceID

public String getReferenceID()

Supported API: false

Specified by:

getReferenceID in interface IBAReferenceable

Returns:

String

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 Simple

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 Simple

Returns:

int