wt.epm.familytable
Class EPMFamilyTableCell

java.lang.Object
  extended bywt.epm.familytable.EPMFamilyTableCell
All Implemented Interfaces:
Externalizable, NetFactor, ObjectMappable, Persistable, Serializable
Direct Known Subclasses:
EPMFamilyTableCellDependency

public class EPMFamilyTableCell
extends Object
implements Persistable, Externalizable

Use the newEPMFamilyTableCell static factory method(s), not the EPMFamilyTableCell 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 COLUMN
          Label for the attribute.
static String COLUMN_REFERENCE
          Label for the attribute.
private  ObjectReference columnReference
           
static String CONTAINER
          Label for the attribute.
static String CONTAINER_REFERENCE
          Label for the attribute.
private  ObjectReference containerReference
           
static String DEFINED_HERE
          Label for the attribute.
private  boolean definedHere
           
static long EXTERNALIZATION_VERSION_UID
           
private  boolean inherited
           
static String INHERITED
          Label for the attribute.
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
private  PersistInfo thePersistInfo
           
 
Fields inherited from interface wt.fc.Persistable
IDENTITY, PERSIST_INFO, TYPE
 
Constructor Summary
EPMFamilyTableCell()
           
 
Method Summary
 void checkAttributes()
          Validate the values of this Persistable object's attributes.
private  void columnReferenceValidate(ObjectReference a_ColumnReference)
           
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.
 EPMFamilyTableColumn getColumn()
          Gets the object for the association that plays role: COLUMN.
 ObjectReference getColumnReference()
          Gets the value of the attribute: COLUMN_REFERENCE.
 String getConceptualClassname()
          Deprecated.  
 EPMContainedIn getContainer()
          Gets the object for the association that plays role: CONTAINER.
 ObjectReference getContainerReference()
          Gets the value of the attribute: CONTAINER_REFERENCE.
 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().
 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 hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
protected  void initialize(boolean inherited, boolean definedHere, EPMFamilyTableColumn column, EPMContainedIn containedInLink)
          Supports initialization, following construction of an instance.
 boolean isDefinedHere()
          Gets the value of the attribute: DEFINED_HERE.
 boolean isInherited()
          Gets the value of the attribute: INHERITED.
static EPMFamilyTableCell newEPMFamilyTableCell(boolean inherited, boolean definedHere, EPMFamilyTableColumn column, EPMContainedIn containedInLink)
          

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(EPMFamilyTableCell thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setColumn(EPMFamilyTableColumn a_Column)
          Sets the object for the association that plays role: COLUMN.
 void setColumnReference(ObjectReference a_ColumnReference)
          Sets the value of the attribute: COLUMN_REFERENCE.
 void setContainer(EPMContainedIn 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 setDefinedHere(boolean a_DefinedHere)
          Sets the value of the attribute: DEFINED_HERE.
 void setInherited(boolean a_Inherited)
          Sets the value of the attribute: INHERITED.
 void setPersistInfo(PersistInfo a_PersistInfo)
          Sets the object for the association that plays role: PERSIST_INFO.
 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

INHERITED

public static final String INHERITED
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

inherited

private boolean inherited

DEFINED_HERE

public static final String DEFINED_HERE
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

definedHere

private boolean definedHere

CONTAINER

public static final String CONTAINER
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

CONTAINER_REFERENCE

public static final String CONTAINER_REFERENCE
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

containerReference

private ObjectReference containerReference

COLUMN

public static final String COLUMN
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

COLUMN_REFERENCE

public static final String COLUMN_REFERENCE
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

columnReference

private ObjectReference columnReference

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

EPMFamilyTableCell

public EPMFamilyTableCell()
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(EPMFamilyTableCell 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

isInherited

public boolean isInherited()
Gets the value of the attribute: INHERITED.

Supported API: false

Returns:
boolean

setInherited

public void setInherited(boolean a_Inherited)
                  throws WTPropertyVetoException
Sets the value of the attribute: INHERITED.

Supported API: false

Parameters:
a_Inherited -
Throws:
WTPropertyVetoException

isDefinedHere

public boolean isDefinedHere()
Gets the value of the attribute: DEFINED_HERE.

Supported API: false

Returns:
boolean

setDefinedHere

public void setDefinedHere(boolean a_DefinedHere)
                    throws WTPropertyVetoException
Sets the value of the attribute: DEFINED_HERE.

Supported API: false

Parameters:
a_DefinedHere -
Throws:
WTPropertyVetoException

getContainer

public EPMContainedIn getContainer()
Gets the object for the association that plays role: CONTAINER.

Supported API: false

Returns:
EPMContainedIn

setContainer

public void setContainer(EPMContainedIn a_Container)
                  throws WTPropertyVetoException,
                         WTException
Sets the object for the association that plays role: CONTAINER.

Supported API: false

Parameters:
a_Container -
Throws:
WTPropertyVetoException
WTException

getContainerReference

public ObjectReference getContainerReference()
Gets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Returns:
ObjectReference

setContainerReference

public void setContainerReference(ObjectReference a_ContainerReference)
                           throws WTPropertyVetoException
Sets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Parameters:
a_ContainerReference -
Throws:
WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(ObjectReference a_ContainerReference)
                                 throws WTPropertyVetoException
Parameters:
a_ContainerReference -
Throws:
WTPropertyVetoException

getColumn

public EPMFamilyTableColumn getColumn()
Gets the object for the association that plays role: COLUMN.

Supported API: false

Returns:
EPMFamilyTableColumn

setColumn

public void setColumn(EPMFamilyTableColumn a_Column)
               throws WTPropertyVetoException,
                      WTException
Sets the object for the association that plays role: COLUMN.

Supported API: false

Parameters:
a_Column -
Throws:
WTPropertyVetoException
WTException

getColumnReference

public ObjectReference getColumnReference()
Gets the value of the attribute: COLUMN_REFERENCE.

Supported API: false

Returns:
ObjectReference

setColumnReference

public void setColumnReference(ObjectReference a_ColumnReference)
                        throws WTPropertyVetoException
Sets the value of the attribute: COLUMN_REFERENCE.

Supported API: false

Parameters:
a_ColumnReference -
Throws:
WTPropertyVetoException

columnReferenceValidate

private void columnReferenceValidate(ObjectReference a_ColumnReference)
                              throws WTPropertyVetoException
Parameters:
a_ColumnReference -
Throws:
WTPropertyVetoException

newEPMFamilyTableCell

public static EPMFamilyTableCell newEPMFamilyTableCell(boolean inherited,
                                                       boolean definedHere,
                                                       EPMFamilyTableColumn column,
                                                       EPMContainedIn containedInLink)
                                                throws WTException


Supported API: false

Parameters:
inherited -
definedHere -
column -
containedInLink -
Returns:
EPMFamilyTableCell
Throws:
WTException

initialize

protected void initialize(boolean inherited,
                          boolean definedHere,
                          EPMFamilyTableColumn column,
                          EPMContainedIn containedInLink)
                   throws WTException
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:
inherited -
definedHere -
column -
containedInLink -
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