wt.dataops.purge
Class PurgeRecord

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.dataops.DataMaintRecord
              wt.dataops.purge.PurgeRecord

All Implemented Interfaces:

AccessControlled, BusinessInformation, CollectionOp, ContentHolder, DisplayIdentification, DomainAdministered, Externalizable, Identified, NetFactor, Notifiable, ObjectMappable, Persistable, RecentlyVisited, Serializable, WTContained, WTContainedIdentified

public class PurgeRecord

extends DataMaintRecord

implements Externalizable

Use the newPurgeRecord static factory method(s), not the PurgeRecord 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
private String	logNamePrefix
protected static long	OLD_FORMAT_VERSION_UID
private String	operandsInfoPrefix
static String	RELATED_RECORD Label for the attribute.
static String	RELATED_RECORD_REFERENCE Label for the attribute.
private ObjectReference	relatedRecordReference
private static String	RESOURCE
(package private) static long	serialVersionUID
private PurgeStatus	status
static String	STATUS Label for the attribute.
private static int	STATUS_UPPER_LIMIT
static String	TASK_EVENT Label for the attribute.
static String	TASK_EVENT_REFERENCE Label for the attribute.
private ObjectReference	taskEventReference

Fields inherited from class wt.dataops.DataMaintRecord

CONTAINER, CONTEXT_PATHS, CREATOR, CRITERIA, DESCRIPTION, MAP, NAME

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.content.ContentHolder

CONTENT_VECTOR, HAS_CONTENTS, HTTP_VECTOR, OPERATION

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.inf.container.WTContainedIdentified

CONTAINER_REFERENCE

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME

Fields inherited from interface wt.dataops.objectcol.CollectionOp

CRITERIA_REFERENCE, MAP_REFERENCE

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

PurgeRecord()

Method Summary

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.
IdentificationObject	getIdentificationObject() Constructs and returns an identification object.
String	getLogNamePrefix() Supported API: false
String	getOperandsInfoPrefix() Supported API: false
ArchiveRecord	getRelatedRecord() Gets the object for the association that plays role: RELATED_RECORD.
ObjectReference	getRelatedRecordReference() Gets the value of the attribute: RELATED_RECORD_REFERENCE.
EnumeratedType	getStatus() Gets the object for the association that plays role: STATUS.
TaskEvent	getTaskEvent() Gets the object for the association that plays role: TASK_EVENT.
ObjectReference	getTaskEventReference() Gets the value of the attribute: TASK_EVENT_REFERENCE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String name, WTContainerRef context) Supports initialization, following construction of an instance.
static PurgeRecord	newPurgeRecord(String name, WTContainerRef context) 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(PurgeRecord thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	relatedRecordReferenceValidate(ObjectReference a_RelatedRecordReference)
void	setRelatedRecord(ArchiveRecord a_RelatedRecord) Sets the object for the association that plays role: RELATED_RECORD.
void	setRelatedRecordReference(ObjectReference a_RelatedRecordReference) Sets the value of the attribute: RELATED_RECORD_REFERENCE.
void	setStatus(EnumeratedType a_Status) Sets the object for the association that plays role: STATUS.
void	setTaskEvent(TaskEvent a_TaskEvent) Sets the object for the association that plays role: TASK_EVENT.
void	setTaskEventReference(ObjectReference a_TaskEventReference) Sets the value of the attribute: TASK_EVENT_REFERENCE.
private void	statusValidate(EnumeratedType a_Status)
private void	taskEventReferenceValidate(ObjectReference a_TaskEventReference)
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.dataops.DataMaintRecord

getContainer, getContainerName, getContainerReference, getContentVector, getContextPaths, getCreator, getCriteria, getCriteriaReference, getDescription, getHttpVector, getLog, getMap, getMapReference, getName, getOperandsInfo, getOperation, isHasContents, readVersion, setContainer, setContainerReference, setContentVector, setContextPaths, setCreator, setCriteria, setCriteriaReference, setDescription, setHasContents, setHttpVector, setMap, setMapReference, setName, setOperation

Methods inherited from class wt.enterprise.Simple

getBusinessType, getDomainRef, getEventSet, getIdentity, initialize, isInheritedDomain, readVersion, setDomainRef, setEventSet, setInheritedDomain

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

STATUS

public static final String STATUS

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

STATUS_UPPER_LIMIT

private static int STATUS_UPPER_LIMIT

status

private PurgeStatus status

TASK_EVENT

public static final String TASK_EVENT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

TASK_EVENT_REFERENCE

public static final String TASK_EVENT_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

taskEventReference

private ObjectReference taskEventReference

RELATED_RECORD

public static final String RELATED_RECORD

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

RELATED_RECORD_REFERENCE

public static final String RELATED_RECORD_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

relatedRecordReference

private ObjectReference relatedRecordReference

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

logNamePrefix

private final String logNamePrefix

See Also:

Constant Field Values

operandsInfoPrefix

private final String operandsInfoPrefix

See Also:

Constant Field Values

Constructor Detail

PurgeRecord

public PurgeRecord()

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 DataMaintRecord

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 DataMaintRecord

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(PurgeRecord 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 DataMaintRecord

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 DataMaintRecord

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

getStatus

public EnumeratedType getStatus()

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

Supported API: false

Specified by:

getStatus in class DataMaintRecord

Returns:

EnumeratedType

setStatus

public void setStatus(EnumeratedType a_Status)
               throws WTPropertyVetoException

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

Supported API: false

Specified by:

setStatus in class DataMaintRecord

Parameters:

a_Status -

Throws:

WTPropertyVetoException

statusValidate

private void statusValidate(EnumeratedType a_Status)
                     throws WTPropertyVetoException

Parameters:

a_Status -

Throws:

WTPropertyVetoException

getTaskEvent

public TaskEvent getTaskEvent()

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

Supported API: false

Specified by:

getTaskEvent in class DataMaintRecord

Returns:

TaskEvent

setTaskEvent

public void setTaskEvent(TaskEvent a_TaskEvent)
                  throws WTPropertyVetoException,
                         WTException

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

Supported API: false

Specified by:

setTaskEvent in class DataMaintRecord

Parameters:

a_TaskEvent -

Throws:

WTPropertyVetoException

WTException

getTaskEventReference

public ObjectReference getTaskEventReference()

Gets the value of the attribute: TASK_EVENT_REFERENCE.

Supported API: false

Returns:

ObjectReference

setTaskEventReference

public void setTaskEventReference(ObjectReference a_TaskEventReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: TASK_EVENT_REFERENCE.

Supported API: false

Parameters:

a_TaskEventReference -

Throws:

WTPropertyVetoException

taskEventReferenceValidate

private void taskEventReferenceValidate(ObjectReference a_TaskEventReference)
                                 throws WTPropertyVetoException

Parameters:

a_TaskEventReference -

Throws:

WTPropertyVetoException

getRelatedRecord

public ArchiveRecord getRelatedRecord()

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

Supported API: false

Returns:

ArchiveRecord

setRelatedRecord

public void setRelatedRecord(ArchiveRecord a_RelatedRecord)
                      throws WTPropertyVetoException,
                             WTException

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

Supported API: false

Parameters:

a_RelatedRecord -

Throws:

WTPropertyVetoException

WTException

getRelatedRecordReference

public ObjectReference getRelatedRecordReference()

Gets the value of the attribute: RELATED_RECORD_REFERENCE.

Supported API: false

Returns:

ObjectReference

setRelatedRecordReference

public void setRelatedRecordReference(ObjectReference a_RelatedRecordReference)
                               throws WTPropertyVetoException

Sets the value of the attribute: RELATED_RECORD_REFERENCE.

Supported API: false

Parameters:

a_RelatedRecordReference -

Throws:

WTPropertyVetoException

relatedRecordReferenceValidate

private void relatedRecordReferenceValidate(ObjectReference a_RelatedRecordReference)
                                     throws WTPropertyVetoException

Parameters:

a_RelatedRecordReference -

Throws:

WTPropertyVetoException

newPurgeRecord

public static PurgeRecord newPurgeRecord(String name,
                                         WTContainerRef context)
                                  throws WTException

Supported API: false

Parameters:

name -

context -

Returns:

PurgeRecord

Throws:

WTException

initialize

protected void initialize(String name,
                          WTContainerRef context)
                   throws WTException

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

Supported API: false

Parameters:

name -

context -

Throws:

WTException

getIdentificationObject

public IdentificationObject getIdentificationObject()
                                             throws WTException

Constructs and returns an identification object. This method is the only way to obtain an identification object.

Supported API: false

Specified by:

getIdentificationObject in interface Identified

Returns:

IdentificationObject

Throws:

WTException

getLogNamePrefix

public String getLogNamePrefix()

Supported API: false

Specified by:

getLogNamePrefix in class DataMaintRecord

Returns:

String

getOperandsInfoPrefix

public String getOperandsInfoPrefix()

Supported API: false

Specified by:

getOperandsInfoPrefix in class DataMaintRecord

Returns:

String

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 DataMaintRecord

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 DataMaintRecord

Returns:

int