wt.csm.navigation
Class ClassificationNode

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.csm.navigation.AbstractNode
              wt.csm.navigation.ClassificationNode

All Implemented Interfaces:

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

public class ClassificationNode

extends AbstractNode

implements CSMReferenceable, IBAHolder, IBAReferenceable, Externalizable

a

Use the newClassificationNode static factory method(s), not the ClassificationNode 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

static String	CLASSIF_STRUCT Label for the attribute.
static String	CLASSIF_STRUCT_REFERENCE Label for the attribute.
private ObjectReference	classifStructReference
private static String	CLASSNAME
static String	CONSTRAINT_EXCEPTION Label for the attribute.
private IBAConstraintException	constraintException
static String	COUNTERPART_ID Label for the attribute; [Replacing internalID from R6.] counterpartID is unique (except when null) among all attribute definitions, attribute organizers, classification nodes, and quantities of measure.
private static int	COUNTERPART_ID_UPPER_LIMIT
private String	counterpartID
static long	EXTERNALIZATION_VERSION_UID
static String	HIERARCHY_ID Label for the attribute.
private static int	HIERARCHY_ID_UPPER_LIMIT
private String	hierarchyID
protected static long	OLD_FORMAT_VERSION_UID
static String	PARENT Label for the attribute.
static String	PARENT_REFERENCE Label for the attribute.
private ObjectReference	parentReference
private static String	RESOURCE
(package private) static long	serialVersionUID
private AttributeContainer	theAttributeContainer

Fields inherited from class wt.csm.navigation.AbstractNode

DESCRIPTION, IMAGE, NAME

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.iba.value.IBAHolder

ATTRIBUTE_CONTAINER

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

ClassificationNode()

Method Summary

private void	classifStructReferenceValidate(ObjectReference a_ClassifStructReference)
private void	counterpartIDValidate(String a_CounterpartID)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
AttributeContainer	getAttributeContainer() Gets the object for the association that plays role: ATTRIBUTE_CONTAINER.
ClassificationStruct	getClassifStruct() Gets the object for the association that plays role: CLASSIF_STRUCT.
ObjectReference	getClassifStructReference() Gets the value of the attribute: CLASSIF_STRUCT_REFERENCE.
String	getConceptualClassname() Deprecated.
IBAConstraintException	getConstraintException() Gets the value of the attribute: CONSTRAINT_EXCEPTION.
String	getCounterpartID() Gets the value of the attribute: COUNTERPART_ID.
String	getHierarchyID() Gets the value of the attribute: HIERARCHY_ID.
String	getIBAReferenceableDisplayString() Supported API: false
ClassificationNode	getParent() Gets the object for the association that plays role: PARENT.
ObjectReference	getParentReference() Gets the value of the attribute: PARENT_REFERENCE.
String	getReferenceID() Supported API: false
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
private void	hierarchyIDValidate(String a_HierarchyID)
protected void	initialize(String name, ClassificationNode parent, ClassificationStruct classStruct) Supports initialization, following construction of an instance.
static ClassificationNode	newClassificationNode() Supported API: false
static ClassificationNode	newClassificationNode(String name, ClassificationNode parent, ClassificationStruct classStruct) Supported API: false
private void	parentReferenceValidate(ObjectReference a_ParentReference)
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(ClassificationNode thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAttributeContainer(AttributeContainer a_AttributeContainer) Sets the object for the association that plays role: ATTRIBUTE_CONTAINER.
void	setClassifStruct(ClassificationStruct a_ClassifStruct) Sets the object for the association that plays role: CLASSIF_STRUCT.
void	setClassifStructReference(ObjectReference a_ClassifStructReference) Sets the value of the attribute: CLASSIF_STRUCT_REFERENCE.
void	setConstraintException(IBAConstraintException a_ConstraintException) Sets the value of the attribute: CONSTRAINT_EXCEPTION.
void	setCounterpartID(String a_CounterpartID) Sets the value of the attribute: COUNTERPART_ID.
void	setHierarchyID(String a_HierarchyID) Sets the value of the attribute: HIERARCHY_ID.
void	setParent(ClassificationNode a_Parent) Sets the object for the association that plays role: PARENT.
void	setParentReference(ObjectReference a_ParentReference) Sets the value of the attribute: PARENT_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.csm.navigation.AbstractNode

getDescription, getImage, getName, readVersion, setDescription, setImage, setName

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

HIERARCHY_ID

public static final String HIERARCHY_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

HIERARCHY_ID_UPPER_LIMIT

private static int HIERARCHY_ID_UPPER_LIMIT

hierarchyID

private String hierarchyID

CONSTRAINT_EXCEPTION

public static final String CONSTRAINT_EXCEPTION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

constraintException

private IBAConstraintException constraintException

COUNTERPART_ID

public static final String COUNTERPART_ID

Label for the attribute; [Replacing internalID from R6.] counterpartID is unique (except when null) among all attribute definitions, attribute organizers, classification nodes, and quantities of measure. It is managed exclusively by CounterPart. Objects created by the CounterPart service will inherit this ID from the CounterPart classification being uploaded. Objects created by some other service will be assigned a unique ID (based on the network address of the server and the database ID of the object) when the object is first downloaded by the CounterPart service. Besides being used by CounterPart in its classification management role, this is the attribute/class/qom ID that is used by PartsLink search.

Supported API: false

See Also:

Constant Field Values

COUNTERPART_ID_UPPER_LIMIT

private static int COUNTERPART_ID_UPPER_LIMIT

counterpartID

private String counterpartID

CLASSIF_STRUCT

public static final String CLASSIF_STRUCT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CLASSIF_STRUCT_REFERENCE

public static final String CLASSIF_STRUCT_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

classifStructReference

private ObjectReference classifStructReference

PARENT

public static final String PARENT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

PARENT_REFERENCE

public static final String PARENT_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

parentReference

private ObjectReference parentReference

theAttributeContainer

private AttributeContainer theAttributeContainer

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

ClassificationNode

public ClassificationNode()

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 AbstractNode

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 AbstractNode

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 AbstractNode

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

getHierarchyID

public String getHierarchyID()

Gets the value of the attribute: HIERARCHY_ID.

Supported API: false

Specified by:

getHierarchyID in interface CSMReferenceable

Returns:

String

setHierarchyID

public void setHierarchyID(String a_HierarchyID)
                    throws WTPropertyVetoException

Sets the value of the attribute: HIERARCHY_ID.

Supported API: false

Parameters:

a_HierarchyID -

Throws:

WTPropertyVetoException

hierarchyIDValidate

private void hierarchyIDValidate(String a_HierarchyID)
                          throws WTPropertyVetoException

Parameters:

a_HierarchyID -

Throws:

WTPropertyVetoException

getConstraintException

public IBAConstraintException getConstraintException()

Gets the value of the attribute: CONSTRAINT_EXCEPTION.

Supported API: false

Returns:

IBAConstraintException

setConstraintException

public void setConstraintException(IBAConstraintException a_ConstraintException)

Sets the value of the attribute: CONSTRAINT_EXCEPTION.

Supported API: false

Parameters:

a_ConstraintException -

getCounterpartID

public String getCounterpartID()

Gets the value of the attribute: COUNTERPART_ID. [Replacing internalID from R6.] counterpartID is unique (except when null) among all attribute definitions, attribute organizers, classification nodes, and quantities of measure. It is managed exclusively by CounterPart. Objects created by the CounterPart service will inherit this ID from the CounterPart classification being uploaded. Objects created by some other service will be assigned a unique ID (based on the network address of the server and the database ID of the object) when the object is first downloaded by the CounterPart service. Besides being used by CounterPart in its classification management role, this is the attribute/class/qom ID that is used by PartsLink search.

Supported API: false

Returns:

String

setCounterpartID

public void setCounterpartID(String a_CounterpartID)
                      throws WTPropertyVetoException

Sets the value of the attribute: COUNTERPART_ID. [Replacing internalID from R6.] counterpartID is unique (except when null) among all attribute definitions, attribute organizers, classification nodes, and quantities of measure. It is managed exclusively by CounterPart. Objects created by the CounterPart service will inherit this ID from the CounterPart classification being uploaded. Objects created by some other service will be assigned a unique ID (based on the network address of the server and the database ID of the object) when the object is first downloaded by the CounterPart service. Besides being used by CounterPart in its classification management role, this is the attribute/class/qom ID that is used by PartsLink search.

Supported API: false

Parameters:

a_CounterpartID -

Throws:

WTPropertyVetoException

counterpartIDValidate

private void counterpartIDValidate(String a_CounterpartID)
                            throws WTPropertyVetoException

Parameters:

a_CounterpartID -

Throws:

WTPropertyVetoException

getClassifStruct

public ClassificationStruct getClassifStruct()

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

Supported API: false

Returns:

ClassificationStruct

setClassifStruct

public void setClassifStruct(ClassificationStruct a_ClassifStruct)
                      throws WTPropertyVetoException,
                             WTException

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

Supported API: false

Parameters:

a_ClassifStruct -

Throws:

WTPropertyVetoException

WTException

getClassifStructReference

public ObjectReference getClassifStructReference()

Gets the value of the attribute: CLASSIF_STRUCT_REFERENCE.

Supported API: false

Returns:

ObjectReference

setClassifStructReference

public void setClassifStructReference(ObjectReference a_ClassifStructReference)
                               throws WTPropertyVetoException

Sets the value of the attribute: CLASSIF_STRUCT_REFERENCE.

Supported API: false

Parameters:

a_ClassifStructReference -

Throws:

WTPropertyVetoException

classifStructReferenceValidate

private void classifStructReferenceValidate(ObjectReference a_ClassifStructReference)
                                     throws WTPropertyVetoException

Parameters:

a_ClassifStructReference -

Throws:

WTPropertyVetoException

getParent

public ClassificationNode getParent()

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

Supported API: false

Returns:

ClassificationNode

setParent

public void setParent(ClassificationNode a_Parent)
               throws WTPropertyVetoException,
                      WTException

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

Supported API: false

Parameters:

a_Parent -

Throws:

WTPropertyVetoException

WTException

getParentReference

public ObjectReference getParentReference()

Gets the value of the attribute: PARENT_REFERENCE.

Supported API: false

Returns:

ObjectReference

setParentReference

public void setParentReference(ObjectReference a_ParentReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: PARENT_REFERENCE.

Supported API: false

Parameters:

a_ParentReference -

Throws:

WTPropertyVetoException

parentReferenceValidate

private void parentReferenceValidate(ObjectReference a_ParentReference)
                              throws WTPropertyVetoException

Parameters:

a_ParentReference -

Throws:

WTPropertyVetoException

newClassificationNode

public static ClassificationNode newClassificationNode(String name,
                                                       ClassificationNode parent,
                                                       ClassificationStruct classStruct)
                                                throws WTException

Supported API: false

Parameters:

name -

parent -

classStruct -

Returns:

ClassificationNode

Throws:

WTException

initialize

protected void initialize(String name,
                          ClassificationNode parent,
                          ClassificationStruct classStruct)
                   throws WTException

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

Supported API: false

Parameters:

name -

parent -

classStruct -

Throws:

WTException

newClassificationNode

public static ClassificationNode newClassificationNode()
                                                throws WTException

Supported API: false

Returns:

ClassificationNode

Throws:

WTException

getAttributeContainer

public AttributeContainer getAttributeContainer()

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

Supported API: false

Specified by:

getAttributeContainer in interface IBAHolder

Returns:

AttributeContainer

setAttributeContainer

public void setAttributeContainer(AttributeContainer a_AttributeContainer)

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

Supported API: false

Specified by:

setAttributeContainer in interface IBAHolder

Parameters:

a_AttributeContainer -

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 AbstractNode

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 AbstractNode

Returns:

int