wt.iba.definition
Class AttributeOrganizer

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.iba.definition.AttributeOrganizer

All Implemented Interfaces:

AccessControlled, AttributeHierarchyChild, AttributeHierarchyParent, BusinessInformation, ChildAttributeOrganizer, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, Notifiable, ObjectMappable, ParentAttributeDefinition, ParentAttributeOrganizer, Persistable, Serializable

public final class AttributeOrganizer

extends Simple

implements ParentAttributeOrganizer, ParentAttributeDefinition, ChildAttributeOrganizer, Externalizable

Attribute organizers are available for the organization of attribute definitions with a foldering mechanism. Each attribute organizer has a unique name among siblings. Attribute organizers can not be children of attribute definitions. Attribute organizers do not effect the hierarchical relationship of attribute definitions, i.e. root attributes can be grouped under different organizers, but are still considered siblings. AttributeOrganizer implements both ParentAttributeDefinition and ParentAttributeOrganizer for allowing a instance of AttributeOrganizer to a parent of either attribute organizers or attribute definitions. AttributeOrganizer also implements ChildAttributeOrganizer to make it can also be a child of a attribute Organizer.

Use the newAttributeOrganizer static factory method(s), not the AttributeOrganizer 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	COUNTERPART_ID Label for the attribute; 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
private String	description
static long	EXTERNALIZATION_VERSION_UID
private String	hierarchyDisplayName
private String	name
protected static long	OLD_FORMAT_VERSION_UID
static String	ORGANIZER_PARENT Label for the attribute.
private ObjectReference	organizerParentReference
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.iba.definition.ChildAttributeOrganizer

ORGANIZER_PARENT_REFERENCE

Fields inherited from interface wt.iba.definition.AttributeHierarchyChild

DESCRIPTION, HIERARCHY_DISPLAY_NAME, NAME

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

AttributeOrganizer()

Method Summary

private void	counterpartIDValidate(String a_CounterpartID)
private void	descriptionValidate(String a_Description)
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.
String	getCounterpartID() Gets the value of the attribute: COUNTERPART_ID.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
String	getHierarchyDisplayName() Gets the value of the attribute: HIERARCHY_DISPLAY_NAME.
String	getName() Gets the value of the attribute: NAME.
ParentAttributeOrganizer	getOrganizerParent() Gets the object for the association that plays role: ORGANIZER_PARENT.
ObjectReference	getOrganizerParentReference() Gets the value of the attribute: ORGANIZER_PARENT_REFERENCE.
AttributeHierarchyParent	getParent() Provides the parent object reference.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
private void	hierarchyDisplayNameValidate(String a_HierarchyDisplayName)
protected void	initialize(String name, String description, ObjectReference parentRef) Supports initialization, following construction of an instance.
protected void	initialize(String name, String description, String hierarchyDisplayName, ObjectReference parentRef) Supports initialization, following construction of an instance.
boolean	isValidChild(AttributeHierarchyChild hierChild) verify if the AttributeHiearchyChild is a valid child.
private void	nameValidate(String a_Name)
static AttributeOrganizer	newAttributeOrganizer(String name, String description, ObjectReference parentRef) Supported API: false
static AttributeOrganizer	newAttributeOrganizer(String name, String description, String hierarchyDisplayName, ObjectReference parentRef) Supported API: false
private void	organizerParentReferenceValidate(ObjectReference a_OrganizerParentReference)
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(AttributeOrganizer thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setCounterpartID(String a_CounterpartID) Sets the value of the attribute: COUNTERPART_ID.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setHierarchyDisplayName(String a_HierarchyDisplayName) Sets the value of the attribute: HIERARCHY_DISPLAY_NAME.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setOrganizerParent(ParentAttributeOrganizer a_OrganizerParent) Sets the object for the association that plays role: ORGANIZER_PARENT.
void	setOrganizerParentReference(ObjectReference a_OrganizerParentReference) Sets the value of the attribute: ORGANIZER_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.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

COUNTERPART_ID

public static final String COUNTERPART_ID

Label for the attribute; 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

ORGANIZER_PARENT

public static final String ORGANIZER_PARENT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

organizerParentReference

private ObjectReference organizerParentReference

name

private String name

description

private String description

hierarchyDisplayName

private String hierarchyDisplayName

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

AttributeOrganizer

public AttributeOrganizer()

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

getCounterpartID

public String getCounterpartID()

Gets the value of the attribute: COUNTERPART_ID. 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. 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

newAttributeOrganizer

public static AttributeOrganizer newAttributeOrganizer(String name,
                                                       String description,
                                                       ObjectReference parentRef)
                                                throws WTException

Supported API: false

Parameters:

name -

description -

parentRef -

Returns:

AttributeOrganizer

Throws:

WTException

initialize

protected void initialize(String name,
                          String description,
                          ObjectReference parentRef)
                   throws WTException

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

Supported API: false

Parameters:

name -

description -

parentRef -

Throws:

WTException

newAttributeOrganizer

public static AttributeOrganizer newAttributeOrganizer(String name,
                                                       String description,
                                                       String hierarchyDisplayName,
                                                       ObjectReference parentRef)
                                                throws WTException

Supported API: false

Parameters:

name -

description -

hierarchyDisplayName - Display name used when the Organizer is used in the context of a hierarchy. For example, The attribute "Length/Diameter/Inner" might have the Display Name "Inner Diameter" and a hierarchyDisplayName of "Inner"

parentRef -

Returns:

AttributeOrganizer

Throws:

WTException

initialize

protected void initialize(String name,
                          String description,
                          String hierarchyDisplayName,
                          ObjectReference parentRef)
                   throws WTException

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

Supported API: false

Parameters:

name -

description -

hierarchyDisplayName - Display name used when the Organizer is used in the context of a hierarchy. For example, The attribute "Length/Diameter/Inner" might have the Display Name "Inner Diameter" and a hierarchyDisplayName of "Inner"

parentRef -

Throws:

WTException

isValidChild

public boolean isValidChild(AttributeHierarchyChild hierChild)

verify if the AttributeHiearchyChild is a valid child. An attribute definition can be the child of another attribute definition if and only if it is of the same concrete class. Or an attribute definition can be a child of another attribute definition.

Supported API: false

Specified by:

isValidChild in interface AttributeHierarchyParent

Parameters:

hierChild -

Returns:

boolean

getOrganizerParent

public ParentAttributeOrganizer getOrganizerParent()

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

Supported API: false

Specified by:

getOrganizerParent in interface ChildAttributeOrganizer

Returns:

ParentAttributeOrganizer

setOrganizerParent

public void setOrganizerParent(ParentAttributeOrganizer a_OrganizerParent)
                        throws WTPropertyVetoException,
                               WTException

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

Supported API: false

Specified by:

setOrganizerParent in interface ChildAttributeOrganizer

Parameters:

a_OrganizerParent -

Throws:

WTPropertyVetoException

WTException

getOrganizerParentReference

public ObjectReference getOrganizerParentReference()

Gets the value of the attribute: ORGANIZER_PARENT_REFERENCE.

Supported API: false

Specified by:

getOrganizerParentReference in interface ChildAttributeOrganizer

Returns:

ObjectReference

setOrganizerParentReference

public void setOrganizerParentReference(ObjectReference a_OrganizerParentReference)
                                 throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZER_PARENT_REFERENCE.

Supported API: false

Specified by:

setOrganizerParentReference in interface ChildAttributeOrganizer

Parameters:

a_OrganizerParentReference -

Throws:

WTPropertyVetoException

organizerParentReferenceValidate

private void organizerParentReferenceValidate(ObjectReference a_OrganizerParentReference)
                                       throws WTPropertyVetoException

Parameters:

a_OrganizerParentReference -

Throws:

WTPropertyVetoException

getName

public String getName()

Gets the value of the attribute: NAME. name is a unique name among the silblings including attribute organizer and attribute definition. This name is displayed only when the attribute definition is viewed in the context of its position within the attribute definition hierarchy.

Supported API: false

Specified by:

getName in interface AttributeHierarchyChild

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. name is a unique name among the silblings including attribute organizer and attribute definition. This name is displayed only when the attribute definition is viewed in the context of its position within the attribute definition hierarchy.

Supported API: false

Specified by:

setName in interface AttributeHierarchyChild

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. A description of the attribute definition

Supported API: false

Specified by:

getDescription in interface AttributeHierarchyChild

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION. A description of the attribute definition

Supported API: false

Specified by:

setDescription in interface AttributeHierarchyChild

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getHierarchyDisplayName

public String getHierarchyDisplayName()

Gets the value of the attribute: HIERARCHY_DISPLAY_NAME.

Supported API: false

Specified by:

getHierarchyDisplayName in interface AttributeHierarchyChild

Returns:

String

setHierarchyDisplayName

public void setHierarchyDisplayName(String a_HierarchyDisplayName)
                             throws WTPropertyVetoException

Sets the value of the attribute: HIERARCHY_DISPLAY_NAME.

Supported API: false

Specified by:

setHierarchyDisplayName in interface AttributeHierarchyChild

Parameters:

a_HierarchyDisplayName -

Throws:

WTPropertyVetoException

hierarchyDisplayNameValidate

private void hierarchyDisplayNameValidate(String a_HierarchyDisplayName)
                                   throws WTPropertyVetoException

Parameters:

a_HierarchyDisplayName -

Throws:

WTPropertyVetoException

getParent

public AttributeHierarchyParent getParent()

Provides the parent object reference.

Supported API: false

Specified by:

getParent in interface AttributeHierarchyChild

Returns:

AttributeHierarchyParent

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