wt.epm.familytable
Class EPMSepFamilyTable

java.lang.Object
  wt.fc.WTObject
      wt.epm.familytable.EPMSepFamilyTable

All Implemented Interfaces:

Externalizable, Serializable, wt.admin.DomainAdministered, ContentHolder, FormatContentHolder, EPMObject, EPMFamilyTable, wt.epm.workspaces.Trackable, wt.epm.workspaces.WorkspaceTrackable, wt.fc.archive.Archiveable, NetFactor, ObjectMappable, Persistable, wt.federation.FederatedLinkHolder, wt.federation.RemotelyLinkable, CabinetBased, Foldered, wt.folder.FolderedNotVisible, FolderEntry, wt.folder.FolderServiceManaged, IteratedFoldered, DisplayIdentification, WTContained, Lockable, Ownable, wt.recent.RecentlyVisited, wt.ufid.Federatable, Baselineable, Iterated, OneOffVersioned, Versionable, Versioned, Workable

public final class EPMSepFamilyTable
extends WTObject
implements EPMFamilyTable, wt.ufid.Federatable, wt.fc.archive.Archiveable, Externalizable

Use the newEPMSepFamilyTable static factory method(s), not the EPMSepFamilyTable 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: true

Extendable: false

See Also:

Serialized Form

Field Summary

static String	AUTHORING_APPLICATION Label for the attribute; Indicates that the named application authored the object.
static String	MASTER Label for the attribute.
static String	MASTER_REFERENCE Label for the attribute.
static String	NAME Label for the attribute.
static String	OWNER_APPLICATION Label for the attribute; Indicate that the named application owns the object.

Fields inherited from interface wt.epm.familytable.EPMFamilyTable

FAMILY_TABLE_MASTER, FAMILY_TABLE_MASTER_REFERENCE

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
EPMAuthoringAppType	getAuthoringApplication() Gets the value of the attribute: AUTHORING_APPLICATION.
wt.vc.ControlBranch	getControlBranch() Gets the value of the attribute: CONTROL_BRANCH.
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.
wt.epm.familytable.EPMFamilyTableMaster	getFamilyTableMaster() Gets the value of the attribute: FAMILY_TABLE_MASTER.
ObjectReference	getFamilyTableMasterReference() Gets the value of the attribute: FAMILY_TABLE_MASTER_REFERENCE.
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.
String	getName() Gets the value of the attribute: NAME.
EPMApplicationType	getOwnerApplication() Gets the value of the attribute: OWNER_APPLICATION.
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	setFamilyTableMaster(wt.epm.familytable.EPMFamilyTableMaster a_FamilyTableMaster) Sets the value of the attribute: FAMILY_TABLE_MASTER.
void	setFamilyTableMasterReference(ObjectReference a_FamilyTableMasterReference) Sets the value of the attribute: FAMILY_TABLE_MASTER_REFERENCE.
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	setName(String a_Name) Sets the value of the attribute: NAME.

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

NAME

public static final String NAME

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

OWNER_APPLICATION

public static final String OWNER_APPLICATION

Label for the attribute; Indicate that the named application owns the object. This attribute is derived from EPMFamilyTableMaster.

The parameter is an EPMApplicationType, so that any sort of checking can be done at run-time.

Supported API: true

See Also:

Constant Field Values

AUTHORING_APPLICATION

public static final String AUTHORING_APPLICATION

Label for the attribute; Indicates that the named application authored the object. This attribute is derived from EPMFamilyTableMaster.

The parameter is an EPMAuthoringAppType, so that any sort of checking can be done at run-time.

Supported API: true

See Also:

Constant Field Values

MASTER

public static final String MASTER

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

MASTER_REFERENCE

public static final String MASTER_REFERENCE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: true

Specified by:

getName in interface EPMFamilyTable

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME.

Supported API: true

Specified by:

setName in interface EPMFamilyTable

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getOwnerApplication

public EPMApplicationType getOwnerApplication()

Gets the value of the attribute: OWNER_APPLICATION. Indicate that the named application owns the object. This attribute is derived from EPMFamilyTableMaster.

The parameter is an EPMApplicationType, so that any sort of checking can be done at run-time.

Supported API: true

Specified by:

getOwnerApplication in interface EPMObject

Returns:

EPMApplicationType

getAuthoringApplication

public EPMAuthoringAppType getAuthoringApplication()

Gets the value of the attribute: AUTHORING_APPLICATION. Indicates that the named application authored the object. This attribute is derived from EPMFamilyTableMaster.

The parameter is an EPMAuthoringAppType, so that any sort of checking can be done at run-time.

Supported API: true

Specified by:

getAuthoringApplication in interface EPMObject

Returns:

EPMAuthoringAppType

getMaster

public Mastered getMaster()

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

Supported API: true

Specified by:

getMaster in interface EPMFamilyTable

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.

Supported API: true

Specified by:

setMaster in interface EPMFamilyTable

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.

Supported API: true

Specified by:

getMasterReference in interface EPMFamilyTable

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.

Supported API: true

Specified by:

setMasterReference in interface EPMFamilyTable

Specified by:

setMasterReference in interface Iterated

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

See Also:

Mastered

getFamilyTableMaster

public wt.epm.familytable.EPMFamilyTableMaster getFamilyTableMaster()

Gets the value of the attribute: FAMILY_TABLE_MASTER.

Supported API: true

Specified by:

getFamilyTableMaster in interface EPMFamilyTable

Returns:

EPMFamilyTableMaster

setFamilyTableMaster

public void setFamilyTableMaster(wt.epm.familytable.EPMFamilyTableMaster a_FamilyTableMaster)
                          throws WTException,
                                 WTPropertyVetoException

Sets the value of the attribute: FAMILY_TABLE_MASTER.

Supported API: true

Specified by:

setFamilyTableMaster in interface EPMFamilyTable

Parameters:

a_FamilyTableMaster -

Throws:

WTException

WTPropertyVetoException

getFamilyTableMasterReference

public ObjectReference getFamilyTableMasterReference()

Gets the value of the attribute: FAMILY_TABLE_MASTER_REFERENCE.

Supported API: true

Specified by:

getFamilyTableMasterReference in interface EPMFamilyTable

Returns:

ObjectReference

setFamilyTableMasterReference

public void setFamilyTableMasterReference(ObjectReference a_FamilyTableMasterReference)
                                   throws WTPropertyVetoException

Sets the value of the attribute: FAMILY_TABLE_MASTER_REFERENCE.

Supported API: true

Specified by:

setFamilyTableMasterReference in interface EPMFamilyTable

Parameters:

a_FamilyTableMasterReference -

Throws:

WTPropertyVetoException

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

In particular, this must check that the modifications to the object were made by an approved application.

Supported API: true

Specified by:

checkAttributes in interface EPMObject

Throws:

InvalidAttributeException

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

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