wt.epm.familytable
Class EPMFamilyTableColumn

java.lang.Object
  wt.epm.familytable.EPMFamilyTableColumn

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

Direct Known Subclasses:

EPMFamilyTableAttribute, EPMFamilyTableFeature, EPMFamilyTableMember, EPMFamilyTableParameter, EPMFamilyTableReference

public abstract class EPMFamilyTableColumn

extends Object

implements Persistable, Externalizable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private int	attribute
static String	ATTRIBUTE Label for the attribute.
private static String	CLASSNAME
static String	COLUMN_TYPE Label for the attribute.
private int	columnType
static long	EXTERNALIZATION_VERSION_UID
static String	FAMILY_TABLE Label for the attribute.
static String	FAMILY_TABLE_REFERENCE Label for the attribute.
private ObjectReference	familyTableReference
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
private String	title
static String	TITLE Label for the attribute.
private static int	TITLE_UPPER_LIMIT

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

EPMFamilyTableColumn()

Method Summary

EPMFamilyTableColumn	duplicate()
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
private void	familyTableReferenceValidate(ObjectReference a_FamilyTableReference)
int	getAttribute() Gets the value of the attribute: ATTRIBUTE.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
int	getColumnType() Gets the value of the attribute: COLUMN_TYPE.
EPMFamilyTable	getFamilyTable() Gets the object for the association that plays role: FAMILY_TABLE.
ObjectReference	getFamilyTableReference() Gets the value of the attribute: FAMILY_TABLE_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().
String	getName() Gets the value of the attribute: NAME.
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
String	getTitle() Gets the value of the attribute: TITLE.
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.
private void	nameValidate(String a_Name)
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(EPMFamilyTableColumn thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAttribute(int a_Attribute) Sets the value of the attribute: ATTRIBUTE.
void	setColumnType(int a_ColumnType) Sets the value of the attribute: COLUMN_TYPE.
void	setFamilyTable(EPMFamilyTable a_FamilyTable) Sets the object for the association that plays role: FAMILY_TABLE.
void	setFamilyTableReference(ObjectReference a_FamilyTableReference) Sets the value of the attribute: FAMILY_TABLE_REFERENCE.
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	setTitle(String a_Title) Sets the value of the attribute: TITLE.
private void	titleValidate(String a_Title)
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

Methods inherited from interface wt.fc.Persistable

checkAttributes

Methods inherited from interface wt.fc.NetFactor

getConceptualClassname

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

TITLE

public static final String TITLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

TITLE_UPPER_LIMIT

private static int TITLE_UPPER_LIMIT

title

private String title

COLUMN_TYPE

public static final String COLUMN_TYPE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

columnType

private int columnType

ATTRIBUTE

public static final String ATTRIBUTE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

attribute

private int attribute

FAMILY_TABLE

public static final String FAMILY_TABLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

FAMILY_TABLE_REFERENCE

public static final String FAMILY_TABLE_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

familyTableReference

private ObjectReference familyTableReference

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

EPMFamilyTableColumn

public EPMFamilyTableColumn()

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

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

getTitle

public String getTitle()

Gets the value of the attribute: TITLE.

Supported API: false

Returns:

String

setTitle

public void setTitle(String a_Title)
              throws WTPropertyVetoException

Sets the value of the attribute: TITLE.

Supported API: false

Parameters:

a_Title -

Throws:

WTPropertyVetoException

titleValidate

private void titleValidate(String a_Title)
                    throws WTPropertyVetoException

Parameters:

a_Title -

Throws:

WTPropertyVetoException

getColumnType

public int getColumnType()

Gets the value of the attribute: COLUMN_TYPE.

Supported API: false

Returns:

int

setColumnType

public void setColumnType(int a_ColumnType)
                   throws WTPropertyVetoException

Sets the value of the attribute: COLUMN_TYPE.

Supported API: false

Parameters:

a_ColumnType -

Throws:

WTPropertyVetoException

getAttribute

public int getAttribute()

Gets the value of the attribute: ATTRIBUTE.

Supported API: false

Returns:

int

setAttribute

public void setAttribute(int a_Attribute)
                  throws WTPropertyVetoException

Sets the value of the attribute: ATTRIBUTE.

Supported API: false

Parameters:

a_Attribute -

Throws:

WTPropertyVetoException

getFamilyTable

public EPMFamilyTable getFamilyTable()

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

Supported API: false

Returns:

EPMFamilyTable

setFamilyTable

public void setFamilyTable(EPMFamilyTable a_FamilyTable)
                    throws WTPropertyVetoException,
                           WTException

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

Supported API: false

Parameters:

a_FamilyTable -

Throws:

WTPropertyVetoException

WTException

getFamilyTableReference

public ObjectReference getFamilyTableReference()

Gets the value of the attribute: FAMILY_TABLE_REFERENCE.

Supported API: false

Returns:

ObjectReference

setFamilyTableReference

public void setFamilyTableReference(ObjectReference a_FamilyTableReference)
                             throws WTPropertyVetoException

Sets the value of the attribute: FAMILY_TABLE_REFERENCE.

Supported API: false

Parameters:

a_FamilyTableReference -

Throws:

WTPropertyVetoException

familyTableReferenceValidate

private void familyTableReferenceValidate(ObjectReference a_FamilyTableReference)
                                   throws WTPropertyVetoException

Parameters:

a_FamilyTableReference -

Throws:

WTPropertyVetoException

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

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

duplicate

public EPMFamilyTableColumn duplicate()
                               throws WTException

Throws:

WTException