wt.enterprise
Class RevisionControlled

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.RevisionControlled

All Implemented Interfaces:

_DepthLock000, _DepthLock001, _DepthLock002, _DepthLock003, _DepthLock004, _DepthLock005, _DepthLock006, _DepthLock007, AccessControlled, AccessControlList, AdHocControlled, Baselineable, BusinessInformation, CabinetBased, Changeable2, ChangeableIfc, DisplayIdentification, DomainAdministered, Externalizable, Foldered, FolderEntry, FolderServiceManaged, Indexable, Iterated, IteratedFoldered, IteratedLifeCycleManaged, IteratedSubjectOfForum, IteratedSubjectOfNotebook, LifeCycleManaged, Lockable, NetFactor, Notifiable, ObjectMappable, Ownable, Persistable, Promotable, Serializable, SubjectOfForum, SubjectOfNotebook, TeamManaged, Versionable, Versioned, Workable

Direct Known Subclasses:

EPMDocument, WTDocument, WTPart, WTUnit

public abstract class RevisionControlled

extends WTObject

implements AccessControlled, DomainAdministered, BusinessInformation, Workable, IteratedFoldered, Versioned, Notifiable, Indexable, IteratedLifeCycleManaged, Changeable2, IteratedSubjectOfNotebook, IteratedSubjectOfForum, Promotable, Externalizable

This wt.lifecycle.LifeCycleManged first class information object is an IteratedFoldered which allows special foldering to take into account its Versioned nature (and it is controlled via a checkin/checkoutmechanism), and it is DomainAdministered; it is similar to Managed except that it is a IteratedFoldered rather than Foldered.

It also has an associated Master which represents the unchanging aspects.

Supported API: true

Extendable: true

See Also:

"'The Enterprise Layer' in 'Application Developer's Guide'", "'vc package -- Version control service' in "'Application Developer's Guide'", "'lifecycle package -- Life cycle management service' in "'Application Developer's Guide'", "'folder package -- Folder service' in "'Application Developer's Guide'", "'admin package -- Domain Administration service' in "'Application Developer's Guide'", Serialized Form

Field Summary

private CheckoutInfo	checkoutInfo
private static String	CLASSNAME
private ControlBranch	controlBranch
private AdminDomainRef	domainRef
private AclEntrySet	entrySet
private WTStringSet	eventSet
static long	EXTERNALIZATION_VERSION_UID
private FolderingInfo	folderingInfo
private IndexerSet	indexerSet
private boolean	inheritedDomain
private IterationInfo	iterationInfo
private Lock	lock
static String	MASTER Label for the attribute; The master for an iteration.
private ObjectReference	masterReference
protected static long	OLD_FORMAT_VERSION_UID
private Ownership	ownership
private static String	RESOURCE
(package private) static long	serialVersionUID
private LifeCycleState	state
private TeamReference	teamId
private TeamTemplateReference	teamTemplateId
static String	VERSION_DISPLAY_IDENTIFIER
static String	VERSION_DISPLAY_IDENTITY
static String	VERSION_DISPLAY_TYPE
private VersionInfo	versionInfo

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

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.vc.wip.Workable

CHECKOUT_INFO

Fields inherited from interface wt.vc.Iterated

BRANCH_IDENTIFIER, CONTROL_BRANCH, CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, ITERATION_IDENTIFIER, ITERATION_INFO, ITERATION_NOTE, LATEST_ITERATION, MASTER_REFERENCE, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.locks.Lockable

LOCK, LOCK_DATE, LOCK_NOTE, LOCKED, LOCKER, LOCKER_EMAIL, LOCKER_FULL_NAME, LOCKER_NAME

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.folder.Foldered

CABINET, CABINET_NAME, FOLDERING_INFO

Fields inherited from interface wt.folder.CabinetBased

CABINET_REFERENCE, FOLDER_PATH, LOCATION, NAME

Fields inherited from interface wt.vc.Versioned

VERSION_IDENTIFIER, VERSION_INFO

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.index.Indexable

INDEXER_SET

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

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

RevisionControlled()

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.
long	getBranchIdentifier() Gets the value of the attribute: BRANCH_IDENTIFIER.
String	getBusinessType() Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getBusinessType(). Another alternative is ((WTObject)obj).getDisplayType().
CabinetReference	getCabinet() Gets the value of the attribute: CABINET.
String	getCabinetName() Gets the value of the attribute: CABINET_NAME.
CabinetReference	getCabinetReference() Gets the value of the attribute: CABINET_REFERENCE.
CheckoutInfo	getCheckoutInfo() Gets the object for the association that plays role: CHECKOUT_INFO.
ControlBranch	getControlBranch() Gets the value of the attribute: CONTROL_BRANCH.
WTPrincipalReference	getCreator() Gets the value of the attribute: 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.
AdminDomainRef	getDomainRef() Gets the object for the association that plays role: DOMAIN_REF.
AclEntrySet	getEntrySet() Gets the value of the attribute: ENTRY_SET.
WTStringSet	getEventSet() Gets the value of the attribute: EVENT_SET.
FolderingInfo	getFolderingInfo() Gets the object for the association that plays role: FOLDERING_INFO.
String	getFolderPath() Gets the value of the attribute: FOLDER_PATH.
String	getIdentity() Constructs and returns a string representing the object's identity.
IndexerSet	getIndexerSet() Gets the value of the attribute: INDEXER_SET.
LocalizableMessage	getIterationDisplayIdentifier()
IterationIdentifier	getIterationIdentifier() Gets the value of the attribute: ITERATION_IDENTIFIER.
IterationInfo	getIterationInfo() Gets the object for the association that plays role: ITERATION_INFO.
String	getIterationNote() Gets the value of the attribute: ITERATION_NOTE.
private IterationInfo	getLazyIterationInfo() The use of this method should be done only if the sender is strictly run on the server.
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.
String	getLocation() Gets the value of the attribute: LOCATION.
Lock	getLock() Gets the object for the association that plays role: LOCK.
Timestamp	getLockDate() Gets the value of the attribute: LOCK_DATE.
WTPrincipalReference	getLocker() Gets the value of the attribute: LOCKER.
String	getLockerEMail() Gets the value of the attribute: LOCKER_EMAIL.
String	getLockerFullName() Gets the value of the attribute: LOCKER_FULL_NAME.
String	getLockerName() Gets the value of the attribute: LOCKER_NAME.
String	getLockNote() Gets the value of the attribute: LOCK_NOTE.
Mastered	getMaster() Gets the object for the association that plays role: MASTER.
ObjectReference	getMasterReference() Gets the value of the attribute: MASTER_REFERENCE.
WTPrincipalReference	getModifier() Gets the value of the attribute: MODIFIER.
String	getModifierEMail() Gets the value of the attribute: MODIFIER_EMAIL.
String	getModifierFullName() Gets the value of the attribute: MODIFIER_FULL_NAME.
String	getModifierName() Gets the value of the attribute: MODIFIER_NAME.
String	getName() Supported API: false
Ownership	getOwnership() Gets the object for the association that plays role: OWNERSHIP.
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.
LocalizableMessage	getVersionDisplayIdentifier() Use IdentityFactory to return the displayable identifier of the object's version.
DisplayIdentity	getVersionDisplayIdentity() Use IdentityFactory to return the displayable identity of the object's version.
LocalizableMessage	getVersionDisplayType() Use IdentityFactory to return the displayable type of object's version.
VersionIdentifier	getVersionIdentifier() Gets the value of the attribute: VERSION_IDENTIFIER.
VersionInfo	getVersionInfo() Gets the object for the association that plays role: VERSION_INFO.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Initializes objects created by new-factory methods.
boolean	isInheritedDomain() Gets the value of the attribute: INHERITED_DOMAIN.
boolean	isLatestIteration() Gets the value of the attribute: LATEST_ITERATION.
boolean	isLifeCycleAtGate() Gets the value of the attribute: LIFE_CYCLE_AT_GATE.
boolean	isLifeCycleBasic() Gets the value of the attribute: LIFE_CYCLE_BASIC.
boolean	isLocked() Gets the value of the attribute: LOCKED.
private void	iterationInfoValidate(IterationInfo a_IterationInfo)
private void	lockValidate(Lock a_Lock)
private void	masterReferenceValidate(ObjectReference a_MasterReference)
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(RevisionControlled thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setCheckoutInfo(CheckoutInfo a_CheckoutInfo) Sets the object for the association that plays role: CHECKOUT_INFO.
void	setControlBranch(ControlBranch a_ControlBranch) Sets the value of the attribute: CONTROL_BRANCH.
void	setDomainRef(AdminDomainRef a_DomainRef) Sets the object for the association that plays role: DOMAIN_REF.
void	setEntrySet(AclEntrySet a_EntrySet) Sets the value of the attribute: ENTRY_SET.
void	setEventSet(WTStringSet a_EventSet) Sets the value of the attribute: EVENT_SET.
void	setFolderingInfo(FolderingInfo a_FolderingInfo) Sets the object for the association that plays role: FOLDERING_INFO.
void	setIndexerSet(IndexerSet a_IndexerSet) Sets the value of the attribute: INDEXER_SET.
void	setInheritedDomain(boolean a_InheritedDomain) Sets the value of the attribute: INHERITED_DOMAIN.
void	setIterationInfo(IterationInfo a_IterationInfo) Sets the object for the association that plays role: ITERATION_INFO.
void	setLock(Lock a_Lock) Sets the object for the association that plays role: LOCK.
void	setMaster(Mastered a_Master) Sets the object for the association that plays role: MASTER.
void	setMasterReference(ObjectReference a_MasterReference) Sets the value of the attribute: MASTER_REFERENCE.
void	setOwnership(Ownership a_Ownership) Sets the object for the association that plays role: OWNERSHIP.
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	setVersionInfo(VersionInfo a_VersionInfo) Sets the object for the association that plays role: VERSION_INFO.
private void	stateValidate(LifeCycleState a_State)
private void	teamIdValidate(TeamReference a_TeamId)
private void	teamTemplateIdValidate(TeamTemplateReference a_TeamTemplateId)
private void	versionInfoValidate(VersionInfo a_VersionInfo)
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.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.NetFactor

getClassInfo, getConceptualClassname

Methods inherited from interface wt.fc.Persistable

checkAttributes, getPersistInfo, getType, setPersistInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

inheritedDomain

private boolean inheritedDomain

domainRef

private AdminDomainRef domainRef

checkoutInfo

private CheckoutInfo checkoutInfo

controlBranch

private ControlBranch controlBranch

iterationInfo

private IterationInfo iterationInfo

MASTER

public static final String MASTER

Label for the attribute; The master for an iteration. A master must exist for any iteration.

Supported API: true

See Also:

Mastered, Constant Field Values

masterReference

private ObjectReference masterReference

lock

private Lock lock

ownership

private Ownership ownership

folderingInfo

private FolderingInfo folderingInfo

versionInfo

private VersionInfo versionInfo

eventSet

private WTStringSet eventSet

indexerSet

private IndexerSet indexerSet

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

VERSION_DISPLAY_TYPE

public static final String VERSION_DISPLAY_TYPE

See Also:

Constant Field Values

VERSION_DISPLAY_IDENTITY

public static final String VERSION_DISPLAY_IDENTITY

See Also:

Constant Field Values

VERSION_DISPLAY_IDENTIFIER

public static final String VERSION_DISPLAY_IDENTIFIER

See Also:

Constant Field Values

Constructor Detail

RevisionControlled

public RevisionControlled()

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 WTObject

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 WTObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(RevisionControlled 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 WTObject

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 WTObject

Parameters:

input -

Throws:

SQLException

DatastoreException

getName

public String getName()

Supported API: false

Specified by:

getName in interface CabinetBased

Returns:

String

getIdentity

public String getIdentity()

Constructs and returns a string representing the object's identity. Typically is the concatenation of the attributes separated by a separator character (for example, "." or "/").

Supported API: false

Specified by:

getIdentity in interface BusinessInformation

Overrides:

getIdentity in class WTObject

Returns:

String

initialize

protected void initialize()
                   throws WTException

Initializes objects created by new-factory methods.

Supported API: false

Overrides:

initialize in class WTObject

Throws:

WTException

getVersionDisplayType

public LocalizableMessage getVersionDisplayType()

Use IdentityFactory to return the displayable type of object's version. The type for the version is for examle Revision, or Revision-View.

Supported API: false

Returns:

LocalizableMessage

getVersionDisplayIdentifier

public LocalizableMessage getVersionDisplayIdentifier()

Use IdentityFactory to return the displayable identifier of the object's version. The identifier for the version might be for example A or B for a Revision.

Supported API: false

Returns:

LocalizableMessage

getVersionDisplayIdentity

public DisplayIdentity getVersionDisplayIdentity()

Use IdentityFactory to return the displayable identity of the object's version. For example this might return an DisplayIdentity object that describes the version as Revision A or Revision A.A of the Manufacturing View.

Supported API: false

Returns:

DisplayIdentity

getLazyIterationInfo

private IterationInfo getLazyIterationInfo()

The use of this method should be done only if the sender is strictly run on the server. Generally cookie info. is not available unless the associated object is persisted. This method makes the cookie info available BEFORE the associated object is persisted.

Returns:

IterationInfo

isInheritedDomain

public boolean isInheritedDomain()

Gets the value of the attribute: INHERITED_DOMAIN. A boolean indicating whether the administrative domain is inherited. If the value is true, the domain is inherited from a parent object.

Supported API: false

Specified by:

isInheritedDomain in interface DomainAdministered

Returns:

boolean

setInheritedDomain

public void setInheritedDomain(boolean a_InheritedDomain)
                        throws WTPropertyVetoException

Sets the value of the attribute: INHERITED_DOMAIN. A boolean indicating whether the administrative domain is inherited. If the value is true, the domain is inherited from a parent object.

Supported API: false

Specified by:

setInheritedDomain in interface DomainAdministered

Parameters:

a_InheritedDomain -

Throws:

WTPropertyVetoException

getDomainRef

public AdminDomainRef getDomainRef()

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

Supported API: false

Specified by:

getDomainRef in interface DomainAdministered

Returns:

AdminDomainRef

setDomainRef

public void setDomainRef(AdminDomainRef a_DomainRef)

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

Supported API: false

Specified by:

setDomainRef in interface DomainAdministered

Parameters:

a_DomainRef -

getBusinessType

public String getBusinessType()

Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getBusinessType(). Another alternative is ((WTObject)obj).getDisplayType().

Gets the value of the attribute: BUSINESS_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:

getBusinessType in interface BusinessInformation

Returns:

String

getCheckoutInfo

public CheckoutInfo getCheckoutInfo()

Gets the object for the association that plays role: CHECKOUT_INFO. The WIP cookie aggregated in any business object that asserts itself as being Workable.

Supported API: false

Specified by:

getCheckoutInfo in interface Workable

Returns:

CheckoutInfo

See Also:

CheckoutInfo

setCheckoutInfo

public void setCheckoutInfo(CheckoutInfo a_CheckoutInfo)
                     throws WTPropertyVetoException

Sets the object for the association that plays role: CHECKOUT_INFO. The WIP cookie aggregated in any business object that asserts itself as being Workable.

Supported API: false

Specified by:

setCheckoutInfo in interface Workable

Parameters:

a_CheckoutInfo -

Throws:

WTPropertyVetoException

See Also:

CheckoutInfo

getIterationNote

public String getIterationNote()

Gets the value of the attribute: ITERATION_NOTE. Derived attribute for displaying the iteration's note in query results.

Supported API: true

Specified by:

getIterationNote in interface Iterated

Returns:

String

getCreatorEMail

public String getCreatorEMail()

Gets the value of the attribute: CREATOR_EMAIL. Derived attribute for displaying the iteration creator's E-Mail address in query results.

Supported API: true

Specified by:

getCreatorEMail in interface Iterated

Returns:

String

getCreatorName

public String getCreatorName()

Gets the value of the attribute: CREATOR_NAME. Derived attribute for displaying the iteration creator's name in query results.

Supported API: true

Specified by:

getCreatorName in interface Iterated

Returns:

String

getCreatorFullName

public String getCreatorFullName()

Gets the value of the attribute: CREATOR_FULL_NAME. Derived attribute for displaying the iteration creator's fullname in query results.

Supported API: true

Specified by:

getCreatorFullName in interface Iterated

Returns:

String

getModifier

public WTPrincipalReference getModifier()

Gets the value of the attribute: MODIFIER. Derived attribute for displaying the iteration's modifier in query results.

Supported API: true

Specified by:

getModifier in interface Iterated

Returns:

WTPrincipalReference

getModifierEMail

public String getModifierEMail()

Gets the value of the attribute: MODIFIER_EMAIL. Derived attribute for displaying the iteration modifier's E-Mail address in query results.

Supported API: true

Specified by:

getModifierEMail in interface Iterated

Returns:

String

getModifierName

public String getModifierName()

Gets the value of the attribute: MODIFIER_NAME. Derived attribute for displaying the iteration modifier's name in query results.

Supported API: true

Specified by:

getModifierName in interface Iterated

Returns:

String

getModifierFullName

public String getModifierFullName()

Gets the value of the attribute: MODIFIER_FULL_NAME. Derived attribute for displaying the iteration modifier's fullname in query results.

Supported API: true

Specified by:

getModifierFullName in interface Iterated

Returns:

String

getIterationIdentifier

public IterationIdentifier getIterationIdentifier()

Gets the value of the attribute: ITERATION_IDENTIFIER. Derived attribute for displaying the iteration identifier in query results.

Supported API: true

Specified by:

getIterationIdentifier in interface Iterated

Returns:

IterationIdentifier

getBranchIdentifier

public long getBranchIdentifier()

Gets the value of the attribute: BRANCH_IDENTIFIER. Derived attribute for displaying the iteration's branch identifier in query results.

Supported API: false

Specified by:

getBranchIdentifier in interface Iterated

Returns:

long

isLatestIteration

public boolean isLatestIteration()

Gets the value of the attribute: LATEST_ITERATION. Derived attribute for displaying the iteration "latest" flag in query results.

Supported API: true

Specified by:

isLatestIteration in interface Iterated

Returns:

boolean

getCreator

public WTPrincipalReference getCreator()

Gets the value of the attribute: CREATOR. Derived attribute for displaying the Version Creator. Will be the same for each iteration of a Version. A Version corresponds to all iterations for a given branchId

Supported API: false

Specified by:

getCreator in interface Iterated

Returns:

WTPrincipalReference

getControlBranch

public ControlBranch getControlBranch()

Gets the value of the attribute: CONTROL_BRANCH.

Supported API: true

Specified by:

getControlBranch in interface Iterated

Returns:

ControlBranch

setControlBranch

public void setControlBranch(ControlBranch a_ControlBranch)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTROL_BRANCH.

Supported API: true

Specified by:

setControlBranch in interface Iterated

Parameters:

a_ControlBranch -

Throws:

WTPropertyVetoException

getIterationInfo

public IterationInfo getIterationInfo()

Gets the object for the association that plays role: ITERATION_INFO. The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Specified by:

getIterationInfo in interface Iterated

Returns:

IterationInfo

See Also:

IterationInfo

setIterationInfo

public void setIterationInfo(IterationInfo a_IterationInfo)
                      throws WTPropertyVetoException

Sets the object for the association that plays role: ITERATION_INFO. The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Specified by:

setIterationInfo in interface Iterated

Parameters:

a_IterationInfo -

Throws:

WTPropertyVetoException

See Also:

IterationInfo

iterationInfoValidate

private void iterationInfoValidate(IterationInfo a_IterationInfo)
                            throws WTPropertyVetoException

Parameters:

a_IterationInfo -

Throws:

WTPropertyVetoException

getMaster

public Mastered getMaster()

Gets the object for the association that plays role: MASTER. The master for an iteration. A master must exist for any iteration.

Supported API: true

Specified by:

getMaster in interface Iterated

Returns:

Mastered

See Also:

Mastered

setMaster

public void setMaster(Mastered a_Master)
               throws WTPropertyVetoException,
                      WTException

Sets the object for the association that plays role: MASTER. The master for an iteration. A master must exist for any iteration.

Supported API: true

Specified by:

setMaster in interface Iterated

Parameters:

a_Master -

Throws:

WTPropertyVetoException

WTException

See Also:

Mastered

getMasterReference

public ObjectReference getMasterReference()

Gets the value of the attribute: MASTER_REFERENCE. The master for an iteration. A master must exist for any iteration.

Supported API: true

Specified by:

getMasterReference in interface Iterated

Returns:

ObjectReference

See Also:

Mastered

setMasterReference

public void setMasterReference(ObjectReference a_MasterReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: MASTER_REFERENCE. The master for an iteration. A master must exist for any iteration.

Supported API: true

Specified by:

setMasterReference in interface Iterated

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

See Also:

Mastered

masterReferenceValidate

private void masterReferenceValidate(ObjectReference a_MasterReference)
                              throws WTPropertyVetoException

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

isLocked

public boolean isLocked()

Gets the value of the attribute: LOCKED. Derived attribute for displaying the isSeized value in query results.

Supported API: false

Specified by:

isLocked in interface Lockable

Returns:

boolean

getLockDate

public Timestamp getLockDate()

Gets the value of the attribute: LOCK_DATE. Derived attribute for displaying the lock date value in query results.

Supported API: false

Specified by:

getLockDate in interface Lockable

Returns:

Timestamp

getLockNote

public String getLockNote()

Gets the value of the attribute: LOCK_NOTE. Derived attribute for displaying the lock note value in query results.

Supported API: false

Specified by:

getLockNote in interface Lockable

Returns:

String

getLocker

public WTPrincipalReference getLocker()

Gets the value of the attribute: LOCKER. Derived attribute for querying for the locker.

Supported API: false

Specified by:

getLocker in interface Lockable

Returns:

WTPrincipalReference

getLockerEMail

public String getLockerEMail()

Gets the value of the attribute: LOCKER_EMAIL. Derived attribute for displaying the locker E-Mail value in query results.

Supported API: false

Specified by:

getLockerEMail in interface Lockable

Returns:

String

getLockerName

public String getLockerName()

Gets the value of the attribute: LOCKER_NAME. Derived attribute for displaying the locker name value in query results.

Supported API: false

Specified by:

getLockerName in interface Lockable

Returns:

String

getLockerFullName

public String getLockerFullName()

Gets the value of the attribute: LOCKER_FULL_NAME. Derived attribute for displaying the lock fullname value in query results.

Supported API: false

Specified by:

getLockerFullName in interface Lockable

Returns:

String

getLock

public Lock getLock()

Gets the object for the association that plays role: LOCK. The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.

Supported API: false

Specified by:

getLock in interface Lockable

Returns:

Lock

See Also:

Lock

setLock

public void setLock(Lock a_Lock)
             throws WTPropertyVetoException

Sets the object for the association that plays role: LOCK. The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.

Supported API: false

Specified by:

setLock in interface Lockable

Parameters:

a_Lock -

Throws:

WTPropertyVetoException

See Also:

Lock

lockValidate

private void lockValidate(Lock a_Lock)
                   throws WTPropertyVetoException

Parameters:

a_Lock -

Throws:

WTPropertyVetoException

getOwnership

public Ownership getOwnership()

Gets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

getOwnership in interface Ownable

Returns:

Ownership

setOwnership

public void setOwnership(Ownership a_Ownership)

Sets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

setOwnership in interface Ownable

Parameters:

a_Ownership -

getCabinetName

public String getCabinetName()

Gets the value of the attribute: CABINET_NAME.

Supported API: false

Specified by:

getCabinetName in interface Foldered

Returns:

String

getCabinet

public CabinetReference getCabinet()

Gets the value of the attribute: CABINET.

Supported API: false

Specified by:

getCabinet in interface Foldered

Returns:

CabinetReference

getFolderingInfo

public FolderingInfo getFolderingInfo()

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

Supported API: false

Specified by:

getFolderingInfo in interface Foldered

Returns:

FolderingInfo

setFolderingInfo

public void setFolderingInfo(FolderingInfo a_FolderingInfo)

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

Supported API: false

Specified by:

setFolderingInfo in interface Foldered

Parameters:

a_FolderingInfo -

getFolderPath

public String getFolderPath()

Gets the value of the attribute: FOLDER_PATH. The complete path for the object. The path includes the location with the name appended. This information is calculated.

Supported API: false

Specified by:

getFolderPath in interface CabinetBased

Returns:

String

getLocation

public String getLocation()

Gets the value of the attribute: LOCATION. The location, described as a path for the object. The location does not include the object's name, but rather indicates what Folder (Cabinet or SubFolder) that the object resides in. This information is calculated.

Supported API: false

Specified by:

getLocation in interface CabinetBased

Returns:

String

getCabinetReference

public CabinetReference getCabinetReference()

Gets the value of the attribute: CABINET_REFERENCE. A reference to the cabinet that the entry is consided part of.

Supported API: false

Specified by:

getCabinetReference in interface CabinetBased

Returns:

CabinetReference

getVersionIdentifier

public VersionIdentifier getVersionIdentifier()

Gets the value of the attribute: VERSION_IDENTIFIER. Derived attribute for displaying the version identifier in query results.

Supported API: false

Specified by:

getVersionIdentifier in interface Versioned

Returns:

VersionIdentifier

getVersionInfo

public VersionInfo getVersionInfo()

Gets the object for the association that plays role: VERSION_INFO. The version cookie aggregated in any business object that asserts itself as being Versioned.

Supported API: false

Specified by:

getVersionInfo in interface Versioned

Returns:

VersionInfo

See Also:

VersionInfo

setVersionInfo

public void setVersionInfo(VersionInfo a_VersionInfo)
                    throws WTPropertyVetoException

Sets the object for the association that plays role: VERSION_INFO. The version cookie aggregated in any business object that asserts itself as being Versioned.

Supported API: false

Specified by:

setVersionInfo in interface Versioned

Parameters:

a_VersionInfo -

Throws:

WTPropertyVetoException

See Also:

VersionInfo

versionInfoValidate

private void versionInfoValidate(VersionInfo a_VersionInfo)
                          throws WTPropertyVetoException

Parameters:

a_VersionInfo -

Throws:

WTPropertyVetoException

getEventSet

public WTStringSet getEventSet()

Gets the value of the attribute: EVENT_SET. Sets of events for which the object has a subscriber.

Supported API: false

Specified by:

getEventSet in interface Notifiable

Returns:

WTStringSet

setEventSet

public void setEventSet(WTStringSet a_EventSet)

Sets the value of the attribute: EVENT_SET. Sets of events for which the object has a subscriber.

Supported API: false

Specified by:

setEventSet in interface Notifiable

Parameters:

a_EventSet -

getIndexerSet

public IndexerSet getIndexerSet()

Gets the value of the attribute: INDEXER_SET.

Supported API: false

Specified by:

getIndexerSet in interface Indexable

Returns:

IndexerSet

setIndexerSet

public void setIndexerSet(IndexerSet a_IndexerSet)

Sets the value of the attribute: INDEXER_SET.

Supported API: false

Specified by:

setIndexerSet in interface Indexable

Parameters:

a_IndexerSet -

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 WTObject

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 WTObject

Returns:

int

getIterationDisplayIdentifier

public LocalizableMessage getIterationDisplayIdentifier()