wt.epm.familytable
Class EPMFamilyTableParameter

java.lang.Object
  extended bywt.epm.familytable.EPMFamilyTableColumn
      extended bywt.epm.familytable.EPMFamilyTableParameter
All Implemented Interfaces:
Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class EPMFamilyTableParameter
extends EPMFamilyTableColumn
implements Externalizable

Use the newEPMFamilyTableParameter static factory method(s), not the EPMFamilyTableParameter 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 DEFINITION
          Label for the attribute.
static String DEFINITION_REFERENCE
          Label for the attribute.
private  ObjectReference definitionReference
           
static long EXTERNALIZATION_VERSION_UID
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
 
Fields inherited from class wt.epm.familytable.EPMFamilyTableColumn
ATTRIBUTE, COLUMN_TYPE, FAMILY_TABLE, FAMILY_TABLE_REFERENCE, NAME, TITLE
 
Fields inherited from interface wt.fc.Persistable
IDENTITY, PERSIST_INFO, TYPE
 
Constructor Summary
EPMFamilyTableParameter()
           
 
Method Summary
 void checkAttributes()
          Validate the values of this Persistable object's attributes.
private  void definitionReferenceValidate(ObjectReference 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.  
 EPMParameterDefinition getDefinition()
          Gets the object for the association that plays role: DEFINITION.
 ObjectReference getDefinitionReference()
          Gets the value of the attribute: DEFINITION_REFERENCE.
 int hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
protected  void initialize()
           
protected  void initialize(String name, String title, int type, int attribute, EPMParameterDefinition definition, EPMFamilyTable familyTable)
          Supports initialization, following construction of an instance.
static EPMFamilyTableParameter newEPMFamilyTableParameter(String name, String title, int type, int attribute, EPMParameterDefinition definition, EPMFamilyTable familyTable)
          

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(EPMFamilyTableParameter thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setDefinition(EPMParameterDefinition a_Definition)
          Sets the object for the association that plays role: DEFINITION.
 void setDefinitionReference(ObjectReference a_DefinitionReference)
          Sets the value of the attribute: DEFINITION_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.epm.familytable.EPMFamilyTableColumn
duplicate, getAttribute, getClassInfo, getColumnType, getFamilyTable, getFamilyTableReference, getIdentity, getName, getPersistInfo, getTitle, getType, readVersion, setAttribute, setColumnType, setFamilyTable, setFamilyTableReference, setName, setPersistInfo, setTitle, toString
 
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

DEFINITION

public static final String DEFINITION
Label for the attribute.

Supported API: true

See Also:
Constant Field Values

DEFINITION_REFERENCE

public static final String DEFINITION_REFERENCE
Label for the attribute.

Supported API: true

See Also:
Constant Field Values

definitionReference

private ObjectReference 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

EPMFamilyTableParameter

public EPMFamilyTableParameter()
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 EPMFamilyTableColumn
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 EPMFamilyTableColumn
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(EPMFamilyTableParameter 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 EPMFamilyTableColumn
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 EPMFamilyTableColumn
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

getDefinition

public EPMParameterDefinition getDefinition()
Gets the object for the association that plays role: DEFINITION.

Supported API: true

Returns:
EPMParameterDefinition

setDefinition

public void setDefinition(EPMParameterDefinition a_Definition)
                   throws WTPropertyVetoException,
                          WTException
Sets the object for the association that plays role: DEFINITION.

Supported API: true

Parameters:
a_Definition -
Throws:
WTPropertyVetoException
WTException

getDefinitionReference

public ObjectReference getDefinitionReference()
Gets the value of the attribute: DEFINITION_REFERENCE.

Supported API: true

Returns:
ObjectReference

setDefinitionReference

public void setDefinitionReference(ObjectReference a_DefinitionReference)
                            throws WTPropertyVetoException
Sets the value of the attribute: DEFINITION_REFERENCE.

Supported API: true

Parameters:
a_DefinitionReference -
Throws:
WTPropertyVetoException

definitionReferenceValidate

private void definitionReferenceValidate(ObjectReference a_DefinitionReference)
                                  throws WTPropertyVetoException
Parameters:
a_DefinitionReference -
Throws:
WTPropertyVetoException

newEPMFamilyTableParameter

public static EPMFamilyTableParameter newEPMFamilyTableParameter(String name,
                                                                 String title,
                                                                 int type,
                                                                 int attribute,
                                                                 EPMParameterDefinition definition,
                                                                 EPMFamilyTable familyTable)
                                                          throws WTException


Supported API: false

Parameters:
name -
title -
type -
attribute -
definition -
familyTable -
Returns:
EPMFamilyTableParameter
Throws:
WTException

initialize

protected void initialize(String name,
                          String title,
                          int type,
                          int attribute,
                          EPMParameterDefinition definition,
                          EPMFamilyTable familyTable)
                   throws WTException
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:
name -
title -
type -
attribute -
definition -
familyTable -
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 EPMFamilyTableColumn
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 EPMFamilyTableColumn
Returns:
int

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException
Description copied from interface: Persistable
Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:
checkAttributes in interface Persistable
Throws:
InvalidAttributeException

initialize

protected void initialize()
                   throws WTException
Throws:
WTException