wt.epm
Class EPMAuthoringAppVersion

java.lang.Object
  wt.epm.EPMAuthoringAppVersion

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class EPMAuthoringAppVersion

extends Object

implements Persistable, Externalizable

Use the newEPMAuthoringAppVersion static factory method(s), not the EPMAuthoringAppVersion 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

static String	AUTHORING_APPLICATION Label for the attribute; Authoring Application.
private static int	AUTHORING_APPLICATION_UPPER_LIMIT
private EPMAuthoringAppType	authoringApplication
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private PersistInfo	thePersistInfo
static String	VERSION_NAME Label for the attribute; Version Name cannot be changed once the object is persisted.
private static int	VERSION_NAME_UPPER_LIMIT
static String	VERSION_NUMBER Label for the attribute; Version Number cannot be changed once the object is persisted.
private String	versionName
private int	versionNumber

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

EPMAuthoringAppVersion()

Method Summary

private void	authoringApplicationValidate(EPMAuthoringAppType a_AuthoringApplication)
void	checkAttributes() Validate the values of this Persistable object's attributes.
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
EPMAuthoringAppType	getAuthoringApplication() Gets the value of the attribute: AUTHORING_APPLICATION.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
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().
String	getVersionName() Gets the value of the attribute: VERSION_NAME.
int	getVersionNumber() Gets the value of the attribute: VERSION_NUMBER.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(EPMAuthoringAppType authoringApplication, int versionNumber, String versionName) Supports initialization, following construction of an instance.
static EPMAuthoringAppVersion	newEPMAuthoringAppVersion(EPMAuthoringAppType authoringApplication, int versionNumber, String versionName) 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(EPMAuthoringAppVersion thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAuthoringApplication(EPMAuthoringAppType a_AuthoringApplication) Sets the value of the attribute: AUTHORING_APPLICATION.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
void	setVersionName(String a_VersionName) Sets the value of the attribute: VERSION_NAME.
void	setVersionNumber(int a_VersionNumber) Sets the value of the attribute: VERSION_NUMBER.
String	toString() Returns the conceptual (modeled) name for the class.
private void	versionNameValidate(String a_VersionName)
private void	versionNumberValidate(int a_VersionNumber)
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

AUTHORING_APPLICATION

public static final String AUTHORING_APPLICATION

Label for the attribute; Authoring Application. The value of authoring application cannot be changed once the object is persisted.

Supported API: false

See Also:

Constant Field Values

AUTHORING_APPLICATION_UPPER_LIMIT

private static int AUTHORING_APPLICATION_UPPER_LIMIT

authoringApplication

private EPMAuthoringAppType authoringApplication

VERSION_NUMBER

public static final String VERSION_NUMBER

Label for the attribute; Version Number cannot be changed once the object is persisted.

Supported API: false

See Also:

Constant Field Values

versionNumber

private int versionNumber

VERSION_NAME

public static final String VERSION_NAME

Label for the attribute; Version Name cannot be changed once the object is persisted. For ProE, the version name is the neutral data version name.

Supported API: false

See Also:

Constant Field Values

VERSION_NAME_UPPER_LIMIT

private static int VERSION_NAME_UPPER_LIMIT

versionName

private String versionName

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

EPMAuthoringAppVersion

public EPMAuthoringAppVersion()

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

getAuthoringApplication

public EPMAuthoringAppType getAuthoringApplication()

Gets the value of the attribute: AUTHORING_APPLICATION. Authoring Application. The value of authoring application cannot be changed once the object is persisted.

Supported API: false

Returns:

EPMAuthoringAppType

setAuthoringApplication

public void setAuthoringApplication(EPMAuthoringAppType a_AuthoringApplication)
                             throws WTPropertyVetoException

Sets the value of the attribute: AUTHORING_APPLICATION. Authoring Application. The value of authoring application cannot be changed once the object is persisted.

Supported API: false

Parameters:

a_AuthoringApplication -

Throws:

WTPropertyVetoException

authoringApplicationValidate

private void authoringApplicationValidate(EPMAuthoringAppType a_AuthoringApplication)
                                   throws WTPropertyVetoException

Parameters:

a_AuthoringApplication -

Throws:

WTPropertyVetoException

getVersionNumber

public int getVersionNumber()

Gets the value of the attribute: VERSION_NUMBER. Version Number cannot be changed once the object is persisted.

Supported API: false

Returns:

int

setVersionNumber

public void setVersionNumber(int a_VersionNumber)
                      throws WTPropertyVetoException

Sets the value of the attribute: VERSION_NUMBER. Version Number cannot be changed once the object is persisted.

Supported API: false

Parameters:

a_VersionNumber -

Throws:

WTPropertyVetoException

versionNumberValidate

private void versionNumberValidate(int a_VersionNumber)
                            throws WTPropertyVetoException

Parameters:

a_VersionNumber -

Throws:

WTPropertyVetoException

getVersionName

public String getVersionName()

Gets the value of the attribute: VERSION_NAME. Version Name cannot be changed once the object is persisted. For ProE, the version name is the neutral data version name.

Supported API: false

Returns:

String

setVersionName

public void setVersionName(String a_VersionName)
                    throws WTPropertyVetoException

Sets the value of the attribute: VERSION_NAME. Version Name cannot be changed once the object is persisted. For ProE, the version name is the neutral data version name.

Supported API: false

Parameters:

a_VersionName -

Throws:

WTPropertyVetoException

versionNameValidate

private void versionNameValidate(String a_VersionName)
                          throws WTPropertyVetoException

Parameters:

a_VersionName -

Throws:

WTPropertyVetoException

newEPMAuthoringAppVersion

public static EPMAuthoringAppVersion newEPMAuthoringAppVersion(EPMAuthoringAppType authoringApplication,
                                                               int versionNumber,
                                                               String versionName)
                                                        throws WTException

Supported API: false

Parameters:

authoringApplication -

versionNumber - Authoring Application, Version Number and Version Name must be unique.

versionName - Authoring Application, Version Number and Version Name must be unique.

Returns:

EPMAuthoringAppVersion

Throws:

WTException

initialize

protected void initialize(EPMAuthoringAppType authoringApplication,
                          int versionNumber,
                          String versionName)
                   throws WTException

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

Supported API: false

Parameters:

authoringApplication -

versionNumber - Authoring Application, Version Number and Version Name must be unique.

versionName - Authoring Application, Version Number and Version Name must be unique.

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