wt.enterprise
Class IteratedFolderResident

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

All Implemented Interfaces:

Externalizable, Serializable, AccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, NetFactor, ObjectMappable, Persistable, CabinetBased, Foldered, FolderEntry, wt.folder.FolderServiceManaged, IteratedFoldered, DisplayIdentification, Lockable, Notifiable, Ownable, Iterated, Workable

public abstract class IteratedFolderResident
extends WTObject
implements Workable, Notifiable, wt.admin.DomainAdministered, wt.access.PolicyAccessControlled, Ownable, IteratedFoldered, wt.access.SecurityLabeled, Externalizable

This Workable (and therefor Iterated) first class information object is IteratedFoldered which allows special foldering behavior to take into account its Iterated nature when displaying it in a folder, and it is DomainAdministered; it is similar to a FolderResident except that it is Workable and is therefor rather than Foldered; it is neither LifeCycleManaged nor Versioned.

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'", "'folder package -- Folder service' in "'Application Developer's Guide'", "'admin package -- Domain Administration service' in "'Application Developer's Guide'", Serialized Form

Field Summary

static String

MASTER Label for the attribute; The master for an iteration.

Fields inherited from interface wt.vc.Iterated

CONTROL_BRANCH, ITERATION_IDENTIFIER, ITERATION_NOTE, LATEST_ITERATION, MASTER_REFERENCE, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME

Fields inherited from interface wt.vc.Iterated

CONTROL_BRANCH, ITERATION_IDENTIFIER, ITERATION_NOTE, LATEST_ITERATION, MASTER_REFERENCE, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME

Method Summary

wt.vc.ControlBranch	getControlBranch() Gets the value of the attribute: CONTROL_BRANCH.
IterationIdentifier	getIterationIdentifier() Gets the value of the attribute: ITERATION_IDENTIFIER.
String	getIterationNote() Gets the value of the attribute: ITERATION_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.
boolean	isLatestIteration() Gets the value of the attribute: LATEST_ITERATION.
void	setControlBranch(wt.vc.ControlBranch a_ControlBranch) Sets the value of the attribute: CONTROL_BRANCH.
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.

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

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

Field Detail

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

Method Detail

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

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

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

getControlBranch

public wt.vc.ControlBranch getControlBranch()

Gets the value of the attribute: CONTROL_BRANCH. Derived attribute for displaying the Control Branch in query results.

Supported API: true

Specified by:

getControlBranch in interface Iterated

Returns:

ControlBranch

setControlBranch

public void setControlBranch(wt.vc.ControlBranch a_ControlBranch)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTROL_BRANCH. Derived attribute for displaying the Control Branch in query results.

Supported API: true

Specified by:

setControlBranch in interface Iterated

Parameters:

a_ControlBranch -

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