wt.epm.familytable
Class EPMFeatureDefinition

java.lang.Object
  wt.epm.familytable.EPMFeatureDefinition

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class EPMFeatureDefinition

extends Object

implements Persistable, Externalizable

Use the newEPMFeatureDefinition static factory method(s), not the EPMFeatureDefinition 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	CONTAINER Label for the attribute.
static String	CONTAINER_REFERENCE Label for the attribute.
private ObjectReference	containerReference
static long	EXTERNALIZATION_VERSION_UID
static String	FEATURE_TYPE Label for the attribute.
private int	featureType
static String	INTERNAL_ID Label for the attribute.
private int	internalId
private String	name
static String	NAME Label for the attribute.
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private PersistInfo	thePersistInfo
static String	VALUE_TYPE Label for the attribute.
private int	valueType

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

EPMFeatureDefinition()

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
private void	containerReferenceValidate(ObjectReference a_ContainerReference)
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.
EPMFeatureDefinitionContainer	getContainer() Gets the object for the association that plays role: CONTAINER.
ObjectReference	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
int	getFeatureType() Gets the value of the attribute: FEATURE_TYPE.
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().
int	getInternalId() Gets the value of the attribute: INTERNAL_ID.
String	getName() Gets the value of the attribute: NAME.
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	getValueType() Gets the value of the attribute: VALUE_TYPE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String name, int internalId, int valueType, int featureType, EPMFamilyTableMaster familyTableMaster) Supports initialization, following construction of an instance.
private void	nameValidate(String a_Name)
static EPMFeatureDefinition	newEPMFeatureDefinition(String name, int internalId, int valueType, int featureType, EPMFamilyTableMaster familyTableMaster) Supported API: false
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(EPMFeatureDefinition thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setContainer(EPMFeatureDefinitionContainer a_Container) Sets the object for the association that plays role: CONTAINER.
void	setContainerReference(ObjectReference a_ContainerReference) Sets the value of the attribute: CONTAINER_REFERENCE.
void	setFeatureType(int a_FeatureType) Sets the value of the attribute: FEATURE_TYPE.
void	setInternalId(int a_InternalId) Sets the value of the attribute: INTERNAL_ID.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
void	setValueType(int a_ValueType) Sets the value of the attribute: VALUE_TYPE.
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

NAME

public static final String NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

INTERNAL_ID

public static final String INTERNAL_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

internalId

private int internalId

VALUE_TYPE

public static final String VALUE_TYPE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

valueType

private int valueType

FEATURE_TYPE

public static final String FEATURE_TYPE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

featureType

private int featureType

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

CONTAINER_REFERENCE

public static final String CONTAINER_REFERENCE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

containerReference

private ObjectReference containerReference

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

EPMFeatureDefinition

public EPMFeatureDefinition()

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

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: false

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME.

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getInternalId

public int getInternalId()

Gets the value of the attribute: INTERNAL_ID.

Supported API: false

Returns:

int

setInternalId

public void setInternalId(int a_InternalId)
                   throws WTPropertyVetoException

Sets the value of the attribute: INTERNAL_ID.

Supported API: false

Parameters:

a_InternalId -

Throws:

WTPropertyVetoException

getValueType

public int getValueType()

Gets the value of the attribute: VALUE_TYPE.

Supported API: false

Returns:

int

setValueType

public void setValueType(int a_ValueType)
                  throws WTPropertyVetoException

Sets the value of the attribute: VALUE_TYPE.

Supported API: false

Parameters:

a_ValueType -

Throws:

WTPropertyVetoException

getFeatureType

public int getFeatureType()

Gets the value of the attribute: FEATURE_TYPE.

Supported API: false

Returns:

int

setFeatureType

public void setFeatureType(int a_FeatureType)
                    throws WTPropertyVetoException

Sets the value of the attribute: FEATURE_TYPE.

Supported API: false

Parameters:

a_FeatureType -

Throws:

WTPropertyVetoException

getContainer

public EPMFeatureDefinitionContainer getContainer()

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

Supported API: true

Returns:

EPMFeatureDefinitionContainer

setContainer

public void setContainer(EPMFeatureDefinitionContainer a_Container)
                  throws WTPropertyVetoException,
                         WTException

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

Supported API: true

Parameters:

a_Container -

Throws:

WTPropertyVetoException

WTException

getContainerReference

public ObjectReference getContainerReference()

Gets the value of the attribute: CONTAINER_REFERENCE.

Supported API: true

Returns:

ObjectReference

setContainerReference

public void setContainerReference(ObjectReference a_ContainerReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_REFERENCE.

Supported API: true

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(ObjectReference a_ContainerReference)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

newEPMFeatureDefinition

public static EPMFeatureDefinition newEPMFeatureDefinition(String name,
                                                           int internalId,
                                                           int valueType,
                                                           int featureType,
                                                           EPMFamilyTableMaster familyTableMaster)
                                                    throws WTException

Supported API: false

Parameters:

name -

internalId -

valueType -

featureType -

familyTableMaster -

Returns:

EPMFeatureDefinition

Throws:

WTException

initialize

protected void initialize(String name,
                          int internalId,
                          int valueType,
                          int featureType,
                          EPMFamilyTableMaster familyTableMaster)
                   throws WTException

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

Supported API: false

Parameters:

name -

internalId -

valueType -

featureType -

familyTableMaster -

Throws:

WTException

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