wt.epm.workspaces
Class EPMInitialCheckinData

java.lang.Object
  wt.epm.workspaces.EPMInitialCheckinData

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class EPMInitialCheckinData

extends Object

implements Persistable, Externalizable

Use the newEPMInitialCheckinData static factory method(s), not the EPMInitialCheckinData 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 long	EXTERNALIZATION_VERSION_UID
static String	NEW_OBJECT Label for the attribute; New EPMDocument or WTPart in EPMWorkspace Supported API: false
static String	NEW_OBJECT_REFERENCE Label for the attribute; New EPMDocument or WTPart in EPMWorkspace Supported API: false
private ObjectReference	newObjectReference
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	TARGET_FOLDER Label for the attribute.
static String	TARGET_FOLDER_REFERENCE Label for the attribute.
private ObjectReference	targetFolderReference
private PersistInfo	thePersistInfo

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

EPMInitialCheckinData()

Method Summary

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.
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().
Baselineable	getNewObject() Gets the object for the association that plays role: NEW_OBJECT.
ObjectReference	getNewObjectReference() Gets the value of the attribute: NEW_OBJECT_REFERENCE.
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
Folder	getTargetFolder() Gets the object for the association that plays role: TARGET_FOLDER.
ObjectReference	getTargetFolderReference() Gets the value of the attribute: TARGET_FOLDER_REFERENCE.
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(Baselineable newObject) Supports initialization, following construction of an instance.
protected void	initialize(ObjectReference newObjectReference) Supports initialization, following construction of an instance.
static EPMInitialCheckinData	newEPMInitialCheckinData(Baselineable newObject) Supported API: false
static EPMInitialCheckinData	newEPMInitialCheckinData(ObjectReference newObjectReference) Supported API: false
private void	newObjectReferenceValidate(ObjectReference a_NewObjectReference)
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(EPMInitialCheckinData thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setNewObject(Baselineable a_NewObject) Sets the object for the association that plays role: NEW_OBJECT.
void	setNewObjectReference(ObjectReference a_NewObjectReference) Sets the value of the attribute: NEW_OBJECT_REFERENCE.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
void	setTargetFolder(Folder a_TargetFolder) Sets the object for the association that plays role: TARGET_FOLDER.
void	setTargetFolderReference(ObjectReference a_TargetFolderReference) Sets the value of the attribute: TARGET_FOLDER_REFERENCE.
private void	targetFolderReferenceValidate(ObjectReference a_TargetFolderReference)
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

NEW_OBJECT

public static final String NEW_OBJECT

Label for the attribute; New EPMDocument or WTPart in EPMWorkspace

Supported API: false

See Also:

Constant Field Values

NEW_OBJECT_REFERENCE

public static final String NEW_OBJECT_REFERENCE

Label for the attribute; New EPMDocument or WTPart in EPMWorkspace

Supported API: false

See Also:

Constant Field Values

newObjectReference

private ObjectReference newObjectReference

TARGET_FOLDER

public static final String TARGET_FOLDER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

TARGET_FOLDER_REFERENCE

public static final String TARGET_FOLDER_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

targetFolderReference

private ObjectReference targetFolderReference

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

EPMInitialCheckinData

public EPMInitialCheckinData()

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

getNewObject

public Baselineable getNewObject()

Gets the object for the association that plays role: NEW_OBJECT. New EPMDocument or WTPart in EPMWorkspace

Supported API: false

Returns:

Baselineable

setNewObject

public void setNewObject(Baselineable a_NewObject)
                  throws WTPropertyVetoException,
                         WTException

Sets the object for the association that plays role: NEW_OBJECT. New EPMDocument or WTPart in EPMWorkspace

Supported API: false

Parameters:

a_NewObject -

Throws:

WTPropertyVetoException

WTException

getNewObjectReference

public ObjectReference getNewObjectReference()

Gets the value of the attribute: NEW_OBJECT_REFERENCE. New EPMDocument or WTPart in EPMWorkspace

Supported API: false

Returns:

ObjectReference

setNewObjectReference

public void setNewObjectReference(ObjectReference a_NewObjectReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: NEW_OBJECT_REFERENCE. New EPMDocument or WTPart in EPMWorkspace

Supported API: false

Parameters:

a_NewObjectReference -

Throws:

WTPropertyVetoException

newObjectReferenceValidate

private void newObjectReferenceValidate(ObjectReference a_NewObjectReference)
                                 throws WTPropertyVetoException

Parameters:

a_NewObjectReference -

Throws:

WTPropertyVetoException

getTargetFolder

public Folder getTargetFolder()

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

Supported API: false

Returns:

Folder

setTargetFolder

public void setTargetFolder(Folder a_TargetFolder)
                     throws WTPropertyVetoException,
                            WTException

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

Supported API: false

Parameters:

a_TargetFolder -

Throws:

WTPropertyVetoException

WTException

getTargetFolderReference

public ObjectReference getTargetFolderReference()

Gets the value of the attribute: TARGET_FOLDER_REFERENCE.

Supported API: false

Returns:

ObjectReference

setTargetFolderReference

public void setTargetFolderReference(ObjectReference a_TargetFolderReference)
                              throws WTPropertyVetoException

Sets the value of the attribute: TARGET_FOLDER_REFERENCE.

Supported API: false

Parameters:

a_TargetFolderReference -

Throws:

WTPropertyVetoException

targetFolderReferenceValidate

private void targetFolderReferenceValidate(ObjectReference a_TargetFolderReference)
                                    throws WTPropertyVetoException

Parameters:

a_TargetFolderReference -

Throws:

WTPropertyVetoException

newEPMInitialCheckinData

public static EPMInitialCheckinData newEPMInitialCheckinData(ObjectReference newObjectReference)
                                                      throws WTException

Supported API: false

Parameters:

newObjectReference -

Returns:

EPMInitialCheckinData

Throws:

WTException

initialize

protected void initialize(ObjectReference newObjectReference)
                   throws WTException

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

Supported API: false

Parameters:

newObjectReference -

Throws:

WTException

newEPMInitialCheckinData

public static EPMInitialCheckinData newEPMInitialCheckinData(Baselineable newObject)
                                                      throws WTException

Supported API: false

Parameters:

newObject -

Returns:

EPMInitialCheckinData

Throws:

WTException

initialize

protected void initialize(Baselineable newObject)
                   throws WTException

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

Supported API: false

Parameters:

newObject -

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