wt.replication.unit
Class UnitOperationRecord

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.replication.unit.UnitOperationRecord

All Implemented Interfaces:

AccessControlled, BusinessInformation, ContentHolder, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, Notifiable, ObjectMappable, Persistable, Serializable

Direct Known Subclasses:

UnitExportRecord, UnitImportRecord, UnitReceiveRecord, UnitSendRecord

public abstract class UnitOperationRecord

extends Simple

implements ContentHolder, Externalizable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private Vector	contentVector
private WTPrincipalReference	creator
static String	CREATOR Label for the attribute.
static String	CREATOR_EMAIL Label for the attribute.
static String	CREATOR_FULL_NAME Label for the attribute.
static String	CREATOR_NAME Label for the attribute.
private String	description
static String	DESCRIPTION Label for the attribute.
private static int	DESCRIPTION_UPPER_LIMIT
static long	EXTERNALIZATION_VERSION_UID
static String	FINISH_TIME Label for the attribute.
private Timestamp	finishTime
private boolean	hasContents
private Vector	httpVector
protected static long	OLD_FORMAT_VERSION_UID
private HttpContentOperation	operation
private static String	RESOURCE
static String	SCHEDULE_ITEM Label for the attribute.
static String	SCHEDULE_ITEM_REFERENCE Label for the attribute.
(package private) static long	serialVersionUID
static String	START_TIME Label for the attribute.
private Timestamp	startTime
private UnitReplicationStatus	status
static String	STATUS Label for the attribute.
private static int	STATUS_UPPER_LIMIT
private ObjectReference	theScheduleItemReference
static String	UNIT Label for the attribute.
static String	UNIT_REFERENCE Label for the attribute.
private ObjectReference	unitReference

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.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

UnitOperationRecord()

Method Summary

private void	creatorValidate(WTPrincipalReference a_Creator)
private void	descriptionValidate(String a_Description)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
Vector	getContentVector() Gets the value of the attribute: CONTENT_VECTOR.
WTPrincipalReference	getCreator() Gets the object for the association that plays role: CREATOR.
String	getCreatorEMail() Gets the value of the attribute: CREATOR_EMAIL.
String	getCreatorFullName() Gets the value of the attribute: CREATOR_FULL_NAME.
String	getCreatorName() Gets the value of the attribute: CREATOR_NAME.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
Timestamp	getFinishTime() Gets the value of the attribute: FINISH_TIME.
Vector	getHttpVector() Gets the value of the attribute: HTTP_VECTOR.
HttpContentOperation	getOperation() Gets the value of the attribute: OPERATION.
ScheduleItem	getSchedItem() A method to get the ScheduleItem for the unit that has access control disabled.
ScheduleItem	getScheduleItem() Gets the object for the association that plays role: SCHEDULE_ITEM.
ObjectReference	getScheduleItemReference() Gets the value of the attribute: SCHEDULE_ITEM_REFERENCE.
Timestamp	getStartTime() Gets the value of the attribute: START_TIME.
UnitReplicationStatus	getStatus() Gets the object for the association that plays role: STATUS.
WTUnit	getUnit() Gets the object for the association that plays role: UNIT.
ObjectReference	getUnitReference() Gets the value of the attribute: UNIT_REFERENCE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(WTUnit unit, ScheduleItem item, String description, Timestamp schTime) Supported API: false
boolean	isHasContents() Gets the value of the attribute: HAS_CONTENTS.
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(UnitOperationRecord thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setContentVector(Vector a_ContentVector) Sets the value of the attribute: CONTENT_VECTOR.
void	setCreator(WTPrincipalReference a_Creator) Sets the object for the association that plays role: CREATOR.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setFinishTime(Timestamp a_FinishTime) Sets the value of the attribute: FINISH_TIME.
void	setHasContents(boolean a_HasContents) Sets the value of the attribute: HAS_CONTENTS.
void	setHttpVector(Vector a_HttpVector) Sets the value of the attribute: HTTP_VECTOR.
void	setOperation(HttpContentOperation a_Operation) Sets the value of the attribute: OPERATION.
void	setScheduleItem(ScheduleItem a_ScheduleItem) Sets the object for the association that plays role: SCHEDULE_ITEM.
void	setScheduleItemReference(ObjectReference a_ScheduleItemReference) Sets the value of the attribute: SCHEDULE_ITEM_REFERENCE.
void	setStartTime(Timestamp a_StartTime) Sets the value of the attribute: START_TIME.
void	setStatus(UnitReplicationStatus a_Status) Sets the object for the association that plays role: STATUS.
void	setStatuses(UnitReplicationStatus status) Supported API: false
void	setUnit(WTUnit a_Unit) Sets the object for the association that plays role: UNIT.
void	setUnitReference(ObjectReference a_UnitReference) Sets the value of the attribute: UNIT_REFERENCE.
protected abstract void	setUnitStatus(UnitReplicationStatus status) Supported API: false
private void	statusValidate(UnitReplicationStatus a_Status)
private void	unitReferenceValidate(ObjectReference a_UnitReference)
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.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, getConceptualClassname

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

CREATOR_EMAIL

public static final String CREATOR_EMAIL

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CREATOR_NAME

public static final String CREATOR_NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CREATOR_FULL_NAME

public static final String CREATOR_FULL_NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

START_TIME

public static final String START_TIME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

startTime

private Timestamp startTime

FINISH_TIME

public static final String FINISH_TIME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

finishTime

private Timestamp finishTime

SCHEDULE_ITEM

public static final String SCHEDULE_ITEM

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

SCHEDULE_ITEM_REFERENCE

public static final String SCHEDULE_ITEM_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

theScheduleItemReference

private ObjectReference theScheduleItemReference

UNIT

public static final String UNIT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

UNIT_REFERENCE

public static final String UNIT_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

unitReference

private ObjectReference unitReference

CREATOR

public static final String CREATOR

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

creator

private WTPrincipalReference creator

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 UnitReplicationStatus status

contentVector

private Vector contentVector

hasContents

private boolean hasContents

operation

private HttpContentOperation operation

httpVector

private Vector httpVector

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

UnitOperationRecord

public UnitOperationRecord()

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 Simple

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 Simple

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(UnitOperationRecord 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 Simple

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 Simple

Parameters:

input -

Throws:

SQLException

DatastoreException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION.

Supported API: false

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION.

Supported API: false

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getCreatorEMail

public String getCreatorEMail()

Gets the value of the attribute: CREATOR_EMAIL.

Supported API: false

Returns:

String

getCreatorName

public String getCreatorName()

Gets the value of the attribute: CREATOR_NAME.

Supported API: false

Returns:

String

getCreatorFullName

public String getCreatorFullName()

Gets the value of the attribute: CREATOR_FULL_NAME.

Supported API: false

Returns:

String

getStartTime

public Timestamp getStartTime()

Gets the value of the attribute: START_TIME.

Supported API: false

Returns:

Timestamp

setStartTime

public void setStartTime(Timestamp a_StartTime)
                  throws WTPropertyVetoException

Sets the value of the attribute: START_TIME.

Supported API: false

Parameters:

a_StartTime -

Throws:

WTPropertyVetoException

getFinishTime

public Timestamp getFinishTime()

Gets the value of the attribute: FINISH_TIME.

Supported API: false

Returns:

Timestamp

setFinishTime

public void setFinishTime(Timestamp a_FinishTime)
                   throws WTPropertyVetoException

Sets the value of the attribute: FINISH_TIME.

Supported API: false

Parameters:

a_FinishTime -

Throws:

WTPropertyVetoException

getScheduleItem

public ScheduleItem getScheduleItem()

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

Supported API: false

Returns:

ScheduleItem

setScheduleItem

public void setScheduleItem(ScheduleItem a_ScheduleItem)
                     throws WTException

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

Supported API: false

Parameters:

a_ScheduleItem -

Throws:

WTException

getScheduleItemReference

public ObjectReference getScheduleItemReference()

Gets the value of the attribute: SCHEDULE_ITEM_REFERENCE.

Supported API: false

Returns:

ObjectReference

setScheduleItemReference

public void setScheduleItemReference(ObjectReference a_ScheduleItemReference)

Sets the value of the attribute: SCHEDULE_ITEM_REFERENCE.

Supported API: false

Parameters:

a_ScheduleItemReference -

getUnit

public WTUnit getUnit()

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

Supported API: false

Returns:

WTUnit

setUnit

public void setUnit(WTUnit a_Unit)
             throws WTPropertyVetoException,
                    WTException

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

Supported API: false

Parameters:

a_Unit -

Throws:

WTPropertyVetoException

WTException

getUnitReference

public ObjectReference getUnitReference()

Gets the value of the attribute: UNIT_REFERENCE.

Supported API: false

Returns:

ObjectReference

setUnitReference

public void setUnitReference(ObjectReference a_UnitReference)
                      throws WTPropertyVetoException

Sets the value of the attribute: UNIT_REFERENCE.

Supported API: false

Parameters:

a_UnitReference -

Throws:

WTPropertyVetoException

unitReferenceValidate

private void unitReferenceValidate(ObjectReference a_UnitReference)
                            throws WTPropertyVetoException

Parameters:

a_UnitReference -

Throws:

WTPropertyVetoException

getCreator

public WTPrincipalReference getCreator()

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

Supported API: false

Returns:

WTPrincipalReference

setCreator

public void setCreator(WTPrincipalReference a_Creator)
                throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

creatorValidate

private void creatorValidate(WTPrincipalReference a_Creator)
                      throws WTPropertyVetoException

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

getStatus

public UnitReplicationStatus getStatus()

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

Supported API: false

Returns:

UnitReplicationStatus

setStatus

public void setStatus(UnitReplicationStatus a_Status)
               throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_Status -

Throws:

WTPropertyVetoException

statusValidate

private void statusValidate(UnitReplicationStatus a_Status)
                     throws WTPropertyVetoException

Parameters:

a_Status -

Throws:

WTPropertyVetoException

initialize

protected void initialize(WTUnit unit,
                          ScheduleItem item,
                          String description,
                          Timestamp schTime)
                   throws WTPropertyVetoException,
                          WTException

Supported API: false

Parameters:

unit -

item -

description -

schTime -

Throws:

WTPropertyVetoException

WTException

setStatuses

public void setStatuses(UnitReplicationStatus status)
                 throws WTPropertyVetoException,
                        WTException

Supported API: false

Parameters:

status -

Throws:

WTPropertyVetoException

WTException

setUnitStatus

protected abstract void setUnitStatus(UnitReplicationStatus status)
                               throws ObjectNoLongerExistsException,
                                      WTException

Supported API: false

Parameters:

status -

Throws:

ObjectNoLongerExistsException

WTException

getSchedItem

public ScheduleItem getSchedItem()
                          throws WTException

A method to get the ScheduleItem for the unit that has access control disabled.

Supported API: false

Returns:

ScheduleItem

Throws:

WTException

getContentVector

public Vector getContentVector()

Gets the value of the attribute: CONTENT_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getContentVector in interface ContentHolder

Returns:

Vector

setContentVector

public void setContentVector(Vector a_ContentVector)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTENT_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setContentVector in interface ContentHolder

Parameters:

a_ContentVector -

Throws:

WTPropertyVetoException

isHasContents

public boolean isHasContents()

Gets the value of the attribute: HAS_CONTENTS. This is a non-persistent variable that is used to pass information from server to client. Should not be directly accessed by the client

Supported API: false

Specified by:

isHasContents in interface ContentHolder

Returns:

boolean

setHasContents

public void setHasContents(boolean a_HasContents)
                    throws WTPropertyVetoException

Sets the value of the attribute: HAS_CONTENTS. This is a non-persistent variable that is used to pass information from server to client. Should not be directly accessed by the client

Supported API: false

Specified by:

setHasContents in interface ContentHolder

Parameters:

a_HasContents -

Throws:

WTPropertyVetoException

getOperation

public HttpContentOperation getOperation()

Gets the value of the attribute: OPERATION.

Supported API: false

Specified by:

getOperation in interface ContentHolder

Returns:

HttpContentOperation

setOperation

public void setOperation(HttpContentOperation a_Operation)
                  throws WTPropertyVetoException

Sets the value of the attribute: OPERATION.

Supported API: false

Specified by:

setOperation in interface ContentHolder

Parameters:

a_Operation -

Throws:

WTPropertyVetoException

getHttpVector

public Vector getHttpVector()

Gets the value of the attribute: HTTP_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getHttpVector in interface ContentHolder

Returns:

Vector

setHttpVector

public void setHttpVector(Vector a_HttpVector)
                   throws WTPropertyVetoException

Sets the value of the attribute: HTTP_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setHttpVector in interface ContentHolder

Parameters:

a_HttpVector -

Throws:

WTPropertyVetoException

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 Simple

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 Simple

Returns:

int