wt.epm.attributes
Class EPMParameterMap

java.lang.Object
  wt.fc.WTObject
      wt.epm.attributes.EPMParameterMap

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class EPMParameterMap

extends WTObject

implements Externalizable

Use the newEPMParameterMap static factory method(s), not the EPMParameterMap 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	DEFINITION_REFERENCE Label for the attribute.
private AttributeDefinitionReference	definitionReference
static long	EXTERNALIZATION_VERSION_UID
static String	IBAHOLDER_REFERENCE Label for the attribute.
protected static long	OLD_FORMAT_VERSION_UID
static String	PARAMETER_NAME Label for the attribute.
private static int	PARAMETER_NAME_UPPER_LIMIT
private String	parameterName
private static String	RESOURCE
(package private) static long	serialVersionUID
private IBAHolderReference	theIBAHolderReference

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.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

EPMParameterMap()

Method Summary

private void	definitionReferenceValidate(AttributeDefinitionReference a_DefinitionReference)
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.
AttributeDefinitionReference	getDefinitionReference() Gets the object for the association that plays role: DEFINITION_REFERENCE.
IBAHolderReference	getIBAHolderReference() Gets the object for the association that plays role: IBAHOLDER_REFERENCE.
String	getParameterName() Gets the value of the attribute: PARAMETER_NAME.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(IBAHolderReference a_ibaHolderRef, AttributeDefinitionReference a_attributeDefinitionReference, String a_parameterName)
static EPMParameterMap	newEPMParameterMap() Default factory for the class.
static EPMParameterMap	newEPMParameterMap(IBAHolderReference a_ibaHolderRef, AttributeDefinitionReference a_attributeDefinitionReference, String a_parameterName) Supported API: false
private void	parameterNameValidate(String a_ParameterName)
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(EPMParameterMap thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDefinitionReference(AttributeDefinitionReference a_DefinitionReference) Sets the object for the association that plays role: DEFINITION_REFERENCE.
void	setIBAHolderReference(IBAHolderReference a_IBAHolderReference) Sets the object for the association that plays role: IBAHOLDER_REFERENCE.
void	setParameterName(String a_ParameterName) Sets the value of the attribute: PARAMETER_NAME.
private void	theIBAHolderReferenceValidate(IBAHolderReference a_IBAHolderReference)
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.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, initialize, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

clone, 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

PARAMETER_NAME

public static final String PARAMETER_NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

PARAMETER_NAME_UPPER_LIMIT

private static int PARAMETER_NAME_UPPER_LIMIT

parameterName

private String parameterName

IBAHOLDER_REFERENCE

public static final String IBAHOLDER_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

theIBAHolderReference

private IBAHolderReference theIBAHolderReference

DEFINITION_REFERENCE

public static final String DEFINITION_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

definitionReference

private AttributeDefinitionReference definitionReference

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

EPMParameterMap

public EPMParameterMap()

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 WTObject

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 WTObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(EPMParameterMap 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 WTObject

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 WTObject

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

getParameterName

public String getParameterName()

Gets the value of the attribute: PARAMETER_NAME.

Supported API: false

Returns:

String

setParameterName

public void setParameterName(String a_ParameterName)
                      throws WTPropertyVetoException

Sets the value of the attribute: PARAMETER_NAME.

Supported API: false

Parameters:

a_ParameterName -

Throws:

WTPropertyVetoException

parameterNameValidate

private void parameterNameValidate(String a_ParameterName)
                            throws WTPropertyVetoException

Parameters:

a_ParameterName -

Throws:

WTPropertyVetoException

getIBAHolderReference

public IBAHolderReference getIBAHolderReference()

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

Supported API: false

Returns:

IBAHolderReference

setIBAHolderReference

public void setIBAHolderReference(IBAHolderReference a_IBAHolderReference)
                           throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_IBAHolderReference -

Throws:

WTPropertyVetoException

theIBAHolderReferenceValidate

private void theIBAHolderReferenceValidate(IBAHolderReference a_IBAHolderReference)
                                    throws WTPropertyVetoException

Parameters:

a_IBAHolderReference -

Throws:

WTPropertyVetoException

getDefinitionReference

public AttributeDefinitionReference getDefinitionReference()

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

Supported API: false

Returns:

AttributeDefinitionReference

setDefinitionReference

public void setDefinitionReference(AttributeDefinitionReference a_DefinitionReference)
                            throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_DefinitionReference -

Throws:

WTPropertyVetoException

definitionReferenceValidate

private void definitionReferenceValidate(AttributeDefinitionReference a_DefinitionReference)
                                  throws WTPropertyVetoException

Parameters:

a_DefinitionReference -

Throws:

WTPropertyVetoException

newEPMParameterMap

public static EPMParameterMap newEPMParameterMap(IBAHolderReference a_ibaHolderRef,
                                                 AttributeDefinitionReference a_attributeDefinitionReference,
                                                 String a_parameterName)
                                          throws WTException

Supported API: false

Parameters:

a_ibaHolderRef -

a_attributeDefinitionReference -

a_parameterName -

Returns:

EPMParameterMap

Throws:

WTException

newEPMParameterMap

public static EPMParameterMap newEPMParameterMap()
                                          throws WTException

Default factory for the class.

Supported API: false

Returns:

EPMParameterMap

Throws:

WTException

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 WTObject

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 WTObject

Returns:

int

initialize

protected void initialize(IBAHolderReference a_ibaHolderRef,
                          AttributeDefinitionReference a_attributeDefinitionReference,
                          String a_parameterName)
                   throws WTException

Throws:

WTException