wt.replication.sender
Class UnitSendRecord

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

All Implemented Interfaces:

AccessControlled, AccessControlList, AdHocControlled, BusinessInformation, ContentHolder, DisplayIdentification, DomainAdministered, Externalizable, LifeCycleManaged, NetFactor, Notifiable, ObjectMappable, Persistable, Serializable, TeamManaged

public class UnitSendRecord

extends UnitOperationRecord

implements LifeCycleManaged, Externalizable

Use the newUnitSendRecord static factory method(s), not the UnitSendRecord 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
private AclEntrySet	entrySet
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	SITE Label for the attribute.
static String	SITE_REFERENCE Label for the attribute.
private LifeCycleState	state
private TeamReference	teamId
private TeamTemplateReference	teamTemplateId
private ObjectReference	theSiteReference
static String	TO_TEAM_TEMPLATE Label for the attribute.
private static int	TO_TEAM_TEMPLATE_UPPER_LIMIT
static String	TO_USER Label for the attribute.
private static int	TO_USER_UPPER_LIMIT
private String	toTeamTemplate
private String	toUser

Fields inherited from class wt.replication.unit.UnitOperationRecord

CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, DESCRIPTION, FINISH_TIME, SCHEDULE_ITEM, SCHEDULE_ITEM_REFERENCE, START_TIME, STATUS, UNIT, UNIT_REFERENCE

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.lifecycle.LifeCycleManaged

LIFE_CYCLE_AT_GATE, LIFE_CYCLE_BASIC, LIFE_CYCLE_NAME, LIFE_CYCLE_STATE, LIFE_CYCLE_TEMPLATE, STATE

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.access.AdHocControlled

ENTRY_SET

Fields inherited from interface wt.team.TeamManaged

TEAM_ID, TEAM_IDENTITY, TEAM_NAME, TEAM_TEMPLATE_ID, TEAM_TEMPLATE_IDENTITY, TEAM_TEMPLATE_NAME

Fields inherited from interface wt.content.ContentHolder

CONTENT_VECTOR, HAS_CONTENTS, HTTP_VECTOR, OPERATION

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

UnitSendRecord()

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.
AclEntrySet	getEntrySet() Gets the value of the attribute: ENTRY_SET.
String	getIdentity() Gets the value of the attribute: IDENTITY.
String	getLifeCycleName() Gets the value of the attribute: LIFE_CYCLE_NAME.
State	getLifeCycleState() Gets the value of the attribute: LIFE_CYCLE_STATE.
LifeCycleTemplateReference	getLifeCycleTemplate() Gets the value of the attribute: LIFE_CYCLE_TEMPLATE.
Site	getSite() Gets the object for the association that plays role: SITE.
ObjectReference	getSiteReference() Gets the value of the attribute: SITE_REFERENCE.
LifeCycleState	getState() Gets the object for the association that plays role: STATE.
TeamReference	getTeamId() Gets the object for the association that plays role: TEAM_ID.
String	getTeamIdentity() Gets the value of the attribute: TEAM_IDENTITY.
String	getTeamName() Gets the value of the attribute: TEAM_NAME.
TeamTemplateReference	getTeamTemplateId() Gets the object for the association that plays role: TEAM_TEMPLATE_ID.
String	getTeamTemplateIdentity() Gets the value of the attribute: TEAM_TEMPLATE_IDENTITY.
String	getTeamTemplateName() Gets the value of the attribute: TEAM_TEMPLATE_NAME.
String	getToTeamTemplate() Gets the value of the attribute: TO_TEAM_TEMPLATE.
String	getToUser() Gets the value of the attribute: TO_USER.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(WTUnit unit, Site site, ScheduleItem item, String description, String toUser, String toTeamTemplate, Timestamp schTime) Supports initialization, following construction of an instance.
boolean	isLifeCycleAtGate() Gets the value of the attribute: LIFE_CYCLE_AT_GATE.
boolean	isLifeCycleBasic() Gets the value of the attribute: LIFE_CYCLE_BASIC.
static UnitSendRecord	newUnitSendRecord(WTUnit unit, Site site, ScheduleItem item, String description, String toUser, String toTeamTemplate, Timestamp schTime) 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(UnitSendRecord thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setEntrySet(AclEntrySet a_EntrySet) Sets the value of the attribute: ENTRY_SET.
void	setSite(Site a_Site) Sets the object for the association that plays role: SITE.
void	setSiteReference(ObjectReference a_SiteReference) Sets the value of the attribute: SITE_REFERENCE.
void	setState(LifeCycleState a_State) Sets the object for the association that plays role: STATE.
void	setTeamId(TeamReference a_TeamId) Sets the object for the association that plays role: TEAM_ID.
void	setTeamTemplateId(TeamTemplateReference a_TeamTemplateId) Sets the object for the association that plays role: TEAM_TEMPLATE_ID.
void	setToTeamTemplate(String a_ToTeamTemplate) Sets the value of the attribute: TO_TEAM_TEMPLATE.
void	setToUser(String a_ToUser) Sets the value of the attribute: TO_USER.
protected void	setUnitStatus(UnitReplicationStatus status) Supported API: false
private void	stateValidate(LifeCycleState a_State)
private void	teamIdValidate(TeamReference a_TeamId)
private void	teamTemplateIdValidate(TeamTemplateReference a_TeamTemplateId)
private void	theSiteReferenceValidate(ObjectReference a_SiteReference)
private void	toTeamTemplateValidate(String a_ToTeamTemplate)
private void	toUserValidate(String a_ToUser)
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.replication.unit.UnitOperationRecord

getContentVector, getCreator, getCreatorEMail, getCreatorFullName, getCreatorName, getDescription, getFinishTime, getHttpVector, getOperation, getSchedItem, getScheduleItem, getScheduleItemReference, getStartTime, getStatus, getUnit, getUnitReference, initialize, isHasContents, readVersion, setContentVector, setCreator, setDescription, setFinishTime, setHasContents, setHttpVector, setOperation, setScheduleItem, setScheduleItemReference, setStartTime, setStatus, setStatuses, setUnit, setUnitReference

Methods inherited from class wt.enterprise.Simple

getBusinessType, getDomainRef, getEventSet, 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, 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

TO_USER

public static final String TO_USER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

TO_USER_UPPER_LIMIT

private static int TO_USER_UPPER_LIMIT

toUser

private String toUser

TO_TEAM_TEMPLATE

public static final String TO_TEAM_TEMPLATE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

TO_TEAM_TEMPLATE_UPPER_LIMIT

private static int TO_TEAM_TEMPLATE_UPPER_LIMIT

toTeamTemplate

private String toTeamTemplate

SITE

public static final String SITE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

SITE_REFERENCE

public static final String SITE_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

theSiteReference

private ObjectReference theSiteReference

state

private LifeCycleState state

entrySet

private AclEntrySet entrySet

teamTemplateId

private TeamTemplateReference teamTemplateId

teamId

private TeamReference teamId

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

UnitSendRecord

public UnitSendRecord()

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 UnitOperationRecord

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 UnitOperationRecord

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 UnitOperationRecord

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

getToUser

public String getToUser()

Gets the value of the attribute: TO_USER.

Supported API: false

Returns:

String

setToUser

public void setToUser(String a_ToUser)
               throws WTPropertyVetoException

Sets the value of the attribute: TO_USER.

Supported API: false

Parameters:

a_ToUser -

Throws:

WTPropertyVetoException

toUserValidate

private void toUserValidate(String a_ToUser)
                     throws WTPropertyVetoException

Parameters:

a_ToUser -

Throws:

WTPropertyVetoException

getToTeamTemplate

public String getToTeamTemplate()

Gets the value of the attribute: TO_TEAM_TEMPLATE.

Supported API: false

Returns:

String

setToTeamTemplate

public void setToTeamTemplate(String a_ToTeamTemplate)
                       throws WTPropertyVetoException

Sets the value of the attribute: TO_TEAM_TEMPLATE.

Supported API: false

Parameters:

a_ToTeamTemplate -

Throws:

WTPropertyVetoException

toTeamTemplateValidate

private void toTeamTemplateValidate(String a_ToTeamTemplate)
                             throws WTPropertyVetoException

Parameters:

a_ToTeamTemplate -

Throws:

WTPropertyVetoException

getSite

public Site getSite()

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

Supported API: false

Returns:

Site

setSite

public void setSite(Site a_Site)
             throws WTPropertyVetoException,
                    WTException

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

Supported API: false

Parameters:

a_Site -

Throws:

WTPropertyVetoException

WTException

getSiteReference

public ObjectReference getSiteReference()

Gets the value of the attribute: SITE_REFERENCE.

Supported API: false

Returns:

ObjectReference

setSiteReference

public void setSiteReference(ObjectReference a_SiteReference)
                      throws WTPropertyVetoException

Sets the value of the attribute: SITE_REFERENCE.

Supported API: false

Parameters:

a_SiteReference -

Throws:

WTPropertyVetoException

theSiteReferenceValidate

private void theSiteReferenceValidate(ObjectReference a_SiteReference)
                               throws WTPropertyVetoException

Parameters:

a_SiteReference -

Throws:

WTPropertyVetoException

newUnitSendRecord

public static UnitSendRecord newUnitSendRecord(WTUnit unit,
                                               Site site,
                                               ScheduleItem item,
                                               String description,
                                               String toUser,
                                               String toTeamTemplate,
                                               Timestamp schTime)
                                        throws WTException,
                                               WTPropertyVetoException

Supported API: false

Parameters:

unit -

site -

item -

description -

toUser -

toTeamTemplate -

schTime -

Returns:

UnitSendRecord

Throws:

WTException

WTPropertyVetoException

initialize

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

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

Supported API: false

Parameters:

unit -

site -

item -

description -

toUser -

toTeamTemplate -

schTime -

Throws:

WTException

WTPropertyVetoException

setUnitStatus

protected void setUnitStatus(UnitReplicationStatus status)
                      throws ObjectNoLongerExistsException,
                             WTException

Supported API: false

Specified by:

setUnitStatus in class UnitOperationRecord

Parameters:

status -

Throws:

ObjectNoLongerExistsException

WTException

getLifeCycleName

public String getLifeCycleName()

Gets the value of the attribute: LIFE_CYCLE_NAME. the Name of the LifeCycle template (a derived attribute)

Supported API: false

Specified by:

getLifeCycleName in interface LifeCycleManaged

Returns:

String

getLifeCycleState

public State getLifeCycleState()

Gets the value of the attribute: LIFE_CYCLE_STATE. the current State of the LifeCycleManaged object (a derived attribute)

Supported API: false

Specified by:

getLifeCycleState in interface LifeCycleManaged

Returns:

State

isLifeCycleAtGate

public boolean isLifeCycleAtGate()

Gets the value of the attribute: LIFE_CYCLE_AT_GATE. the current AtGate flag on the LifeCycleManaged object (a derived attribute)

Supported API: false

Specified by:

isLifeCycleAtGate in interface LifeCycleManaged

Returns:

boolean

getLifeCycleTemplate

public LifeCycleTemplateReference getLifeCycleTemplate()

Gets the value of the attribute: LIFE_CYCLE_TEMPLATE. the LifeCycleTemplate of the LifeCycleManaged object (a derived attribute)

Supported API: false

Specified by:

getLifeCycleTemplate in interface LifeCycleManaged

Returns:

LifeCycleTemplateReference

isLifeCycleBasic

public boolean isLifeCycleBasic()

Gets the value of the attribute: LIFE_CYCLE_BASIC. This attribute is used to specify if the lifecycle template is basic (no roles, ad hoc access, workflows or criteria) or advanced (may contain roles, ad hoc access, access, workfow and criteria).

Supported API: false

Specified by:

isLifeCycleBasic in interface LifeCycleManaged

Returns:

boolean

getState

public LifeCycleState getState()

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

Supported API: false

Specified by:

getState in interface LifeCycleManaged

Returns:

LifeCycleState

setState

public void setState(LifeCycleState a_State)
              throws WTPropertyVetoException

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

Supported API: false

Specified by:

setState in interface LifeCycleManaged

Parameters:

a_State -

Throws:

WTPropertyVetoException

stateValidate

private void stateValidate(LifeCycleState a_State)
                    throws WTPropertyVetoException

Parameters:

a_State -

Throws:

WTPropertyVetoException

getEntrySet

public AclEntrySet getEntrySet()

Gets the value of the attribute: ENTRY_SET.

Supported API: false

Specified by:

getEntrySet in interface AdHocControlled

Returns:

AclEntrySet

setEntrySet

public void setEntrySet(AclEntrySet a_EntrySet)

Sets the value of the attribute: ENTRY_SET.

Supported API: false

Specified by:

setEntrySet in interface AdHocControlled

Parameters:

a_EntrySet -

getTeamName

public String getTeamName()

Gets the value of the attribute: TEAM_NAME. The name of the team(a derived attribute)

Supported API: false

Specified by:

getTeamName in interface TeamManaged

Returns:

String

getTeamIdentity

public String getTeamIdentity()

Gets the value of the attribute: TEAM_IDENTITY. The identity of the team (a derived attribute)

Supported API: false

Specified by:

getTeamIdentity in interface TeamManaged

Returns:

String

getTeamTemplateName

public String getTeamTemplateName()

Gets the value of the attribute: TEAM_TEMPLATE_NAME. The name of the teamTemplate(a derived attribute)

Supported API: false

Specified by:

getTeamTemplateName in interface TeamManaged

Returns:

String

getTeamTemplateIdentity

public String getTeamTemplateIdentity()

Gets the value of the attribute: TEAM_TEMPLATE_IDENTITY. The identity of the TeamTemplate (a derived attribute)

Supported API: false

Specified by:

getTeamTemplateIdentity in interface TeamManaged

Returns:

String

getTeamTemplateId

public TeamTemplateReference getTeamTemplateId()

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

Supported API: false

Specified by:

getTeamTemplateId in interface TeamManaged

Returns:

TeamTemplateReference

setTeamTemplateId

public void setTeamTemplateId(TeamTemplateReference a_TeamTemplateId)
                       throws WTPropertyVetoException

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

Supported API: false

Specified by:

setTeamTemplateId in interface TeamManaged

Parameters:

a_TeamTemplateId -

Throws:

WTPropertyVetoException

teamTemplateIdValidate

private void teamTemplateIdValidate(TeamTemplateReference a_TeamTemplateId)
                             throws WTPropertyVetoException

Parameters:

a_TeamTemplateId -

Throws:

WTPropertyVetoException

getTeamId

public TeamReference getTeamId()

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

Supported API: false

Specified by:

getTeamId in interface TeamManaged

Returns:

TeamReference

setTeamId

public void setTeamId(TeamReference a_TeamId)
               throws WTPropertyVetoException

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

Supported API: false

Specified by:

setTeamId in interface TeamManaged

Parameters:

a_TeamId -

Throws:

WTPropertyVetoException

teamIdValidate

private void teamIdValidate(TeamReference a_TeamId)
                     throws WTPropertyVetoException

Parameters:

a_TeamId -

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 UnitOperationRecord

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 UnitOperationRecord

Returns:

int

getIdentity

public String getIdentity()

Description copied from interface: Persistable

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

Overrides:

getIdentity in class Simple

Returns:

String