wt.projmgmt.admin
Class Project2

java.lang.Object
  wt.fc.WTObject
      wt.projmgmt.admin.Project2

All Implemented Interfaces:

Externalizable, Serializable, AccessControlled, wt.access.AccessControlList, wt.access.AdHocControlled, IdentityAccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, Identified, NetFactor, ObjectMappable, Persistable, wt.federation.FederatedLinkHolder, wt.federation.RemotelyLinkable, wt.iba.value.IBAHolder, DisplayIdentification, Indexable, WTContained, WTContainedIdentified, WTContainer, ContainerTeamManaged, Notifiable, OrganizationOwned, OrganizationOwnedImpl, wt.recent.RecentlyVisited, wt.type.FlexTyped, wt.type.Typed, wt.ufid.Federatable, wt.workflow.forum.SubjectOfForum, wt.workflow.notebook.SubjectOfNotebook

public class Project2
extends WTObject
implements ContainerTeamManaged, wt.type.Typed, WTContainer, Indexable, Notifiable, Externalizable

Project2 represents a"temporary endeavor undertaken to create a unique product or service." As such it has start and end dates.

Project2 can also be thought as a container of objects (for example, documents and parts) and processes (such as lifecycles and workflows). The objects and processes are aggregated indirectly, through the domains that are associated to the project.

This class serves also to model quasi-project objects such as organizations and programs.

Use the newProject2 static factory method(s), not the Project2 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	BUDGET Label for the attribute; Total amount alloted for the execution of the project.
static String	BUSINESS_LOCATION Label for the attribute; Possible sites the project may be associated with.
static String	BUSINESS_UNIT Label for the attribute; Organizational entity the project is associated with.
static String	CATEGORY Label for the attribute; the type or category of the project.
static String	CONTAINER_TEMPLATE Label for the attribute.
static String	HEALTH_STATUS Label for the attribute; the project health status.
static String	PHASE Label for the attribute; the phase of the project object.
static String	PROJECT_NUMBER Label for the attribute; Identification of the project that is menaingful within the scope of an organization.
static String	SCOPE Label for the attribute; description of the project scope Supported API: true

Fields inherited from interface wt.inf.team.ContainerTeamManaged

CTM_STATE, INVITATION_MSG

Fields inherited from interface wt.inf.container.WTContainer

CONTAINER_TEMPLATE_REFERENCE, CREATOR, DESCRIPTION, NAME, OWNER, SHARING_ENABLED

Fields inherited from interface wt.org.OrganizationOwnedImpl

ORGANIZATION_REFERENCE

Fields inherited from interface wt.org.OrganizationOwned

ORGANIZATION, ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Method Summary

Currency	getBudget() Gets the value of the attribute: BUDGET.
String	getBusinessLocation() Gets the value of the attribute: BUSINESS_LOCATION.
String	getBusinessUnit() Gets the value of the attribute: BUSINESS_UNIT.
ProjectCategory	getCategory() Gets the value of the attribute: CATEGORY.
WTContainerTemplate	getContainerTemplate() Gets the object for the association that plays role: CONTAINER_TEMPLATE.
wt.inf.container.WTContainerTemplateRef	getContainerTemplateReference() Gets the value of the attribute: CONTAINER_TEMPLATE_REFERENCE.
WTPrincipal	getCreator() Gets the value of the attribute: CREATOR.
ContainerTeamManagedState	getCtmState() Gets the value of the attribute: CTM_STATE.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
ProjectHealthStatus	getHealthStatus() Gets the value of the attribute: HEALTH_STATUS.
IdentificationObject	getIdentificationObject() Constructs and returns an identification object.
String	getInvitationMsg() Gets the value of the attribute: INVITATION_MSG.
String	getName() Gets the value of the attribute: NAME.
WTOrganization	getOrganization() Gets the value of the attribute: ORGANIZATION.
String	getOrganizationCodingSystem() Gets the value of the attribute: ORGANIZATION_CODING_SYSTEM.
String	getOrganizationName() Gets the value of the attribute: ORGANIZATION_NAME.
WTPrincipalReference	getOrganizationReference() Gets the value of the attribute: ORGANIZATION_REFERENCE.
String	getOrganizationUniqueIdentifier() Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER.
WTPrincipal	getOwner() Gets the value of the attribute: OWNER.
ProjectPhase	getPhase() Gets the value of the attribute: PHASE.
String	getProjectNumber() Gets the value of the attribute: PROJECT_NUMBER.
ProjectPlan	getProjectPlan() Return the ProjectPlan that is associated with this Project2 or null if none exists.
String	getScope() Gets the value of the attribute: SCOPE.
boolean	isProgram() Supported API: true
static boolean	isProgram(WTReference ref) Supported API: true
boolean	isSharingEnabled() Gets the value of the attribute: SHARING_ENABLED.
void	setBudget(Currency a_Budget) Sets the value of the attribute: BUDGET.
void	setBusinessLocation(String a_BusinessLocation) Sets the value of the attribute: BUSINESS_LOCATION.
void	setBusinessUnit(String a_BusinessUnit) Sets the value of the attribute: BUSINESS_UNIT.
void	setCategory(ProjectCategory a_Category) Sets the value of the attribute: CATEGORY.
void	setContainerTemplate(WTContainerTemplate a_ContainerTemplate) Sets the object for the association that plays role: CONTAINER_TEMPLATE.
void	setContainerTemplateReference(wt.inf.container.WTContainerTemplateRef a_ContainerTemplateReference) Sets the value of the attribute: CONTAINER_TEMPLATE_REFERENCE.
void	setCreator(WTPrincipal a_Creator) Sets the value of the attribute: CREATOR.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setHealthStatus(ProjectHealthStatus a_HealthStatus) Sets the value of the attribute: HEALTH_STATUS.
void	setInvitationMsg(String a_InvitationMsg) Sets the value of the attribute: INVITATION_MSG.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setOrganization(WTOrganization a_Organization) Sets the value of the attribute: ORGANIZATION.
void	setOrganizationReference(WTPrincipalReference a_OrganizationReference) Sets the value of the attribute: ORGANIZATION_REFERENCE.
void	setOwner(WTPrincipal a_Owner) Sets the value of the attribute: OWNER.
void	setPhase(ProjectPhase a_Phase) Sets the value of the attribute: PHASE.
void	setProjectNumber(String a_ProjectNumber) Sets the value of the attribute: PROJECT_NUMBER.
void	setScope(String a_Scope) Sets the value of the attribute: SCOPE.
void	setSharingEnabled(boolean a_SharingEnabled) Sets the value of the attribute: SHARING_ENABLED.

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

SCOPE

public static final String SCOPE

Label for the attribute; description of the project scope

Supported API: true

See Also:

Constant Field Values

PHASE

public static final String PHASE

Label for the attribute; the phase of the project object. Examples include: Kickoff, Scoping, Planning, Assignment, Development, Wrapup, Completed, Postmortem, Cancelled.

Supported API: true

See Also:

Constant Field Values

HEALTH_STATUS

public static final String HEALTH_STATUS

Label for the attribute; the project health status. Example include Green, Yellow, Red. Green means that the project is under control and is proceeding as planned on the schedule. Yellow means that a project is somewhat behind schedule or somewhat at risk. Red means the project is in trouble (over budget or behind schedule).

Supported API: true

See Also:

Constant Field Values

CATEGORY

public static final String CATEGORY

Label for the attribute; the type or category of the project. This category is the same category that is defined in the ProjectTemplate.

Supported API: true

See Also:

Constant Field Values

PROJECT_NUMBER

public static final String PROJECT_NUMBER

Label for the attribute; Identification of the project that is menaingful within the scope of an organization.

Supported API: true

See Also:

Constant Field Values

BUSINESS_UNIT

public static final String BUSINESS_UNIT

Label for the attribute; Organizational entity the project is associated with. Each organization has a list of its units.

Supported API: true

See Also:

Constant Field Values

BUSINESS_LOCATION

public static final String BUSINESS_LOCATION

Label for the attribute; Possible sites the project may be associated with. Each organization should have a list of possible business locations.

Supported API: true

See Also:

Constant Field Values

BUDGET

public static final String BUDGET

Label for the attribute; Total amount alloted for the execution of the project.

Supported API: true

See Also:

Constant Field Values

CONTAINER_TEMPLATE

public static final String CONTAINER_TEMPLATE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getScope

public String getScope()

Gets the value of the attribute: SCOPE. description of the project scope

Supported API: true

Returns:

String

setScope

public void setScope(String a_Scope)
              throws WTPropertyVetoException

Sets the value of the attribute: SCOPE. description of the project scope

Supported API: true

Parameters:

a_Scope -

Throws:

WTPropertyVetoException

getPhase

public ProjectPhase getPhase()

Gets the value of the attribute: PHASE. the phase of the project object. Examples include: Kickoff, Scoping, Planning, Assignment, Development, Wrapup, Completed, Postmortem, Cancelled.

Supported API: true

Returns:

ProjectPhase

setPhase

public void setPhase(ProjectPhase a_Phase)
              throws WTPropertyVetoException

Sets the value of the attribute: PHASE. the phase of the project object. Examples include: Kickoff, Scoping, Planning, Assignment, Development, Wrapup, Completed, Postmortem, Cancelled.

Supported API: true

Parameters:

a_Phase -

Throws:

WTPropertyVetoException

getHealthStatus

public ProjectHealthStatus getHealthStatus()

Gets the value of the attribute: HEALTH_STATUS. the project health status. Example include Green, Yellow, Red. Green means that the project is under control and is proceeding as planned on the schedule. Yellow means that a project is somewhat behind schedule or somewhat at risk. Red means the project is in trouble (over budget or behind schedule).

Supported API: true

Returns:

ProjectHealthStatus

setHealthStatus

public void setHealthStatus(ProjectHealthStatus a_HealthStatus)
                     throws WTPropertyVetoException

Sets the value of the attribute: HEALTH_STATUS. the project health status. Example include Green, Yellow, Red. Green means that the project is under control and is proceeding as planned on the schedule. Yellow means that a project is somewhat behind schedule or somewhat at risk. Red means the project is in trouble (over budget or behind schedule).

Supported API: true

Parameters:

a_HealthStatus -

Throws:

WTPropertyVetoException

getCategory

public ProjectCategory getCategory()

Gets the value of the attribute: CATEGORY. the type or category of the project. This category is the same category that is defined in the ProjectTemplate.

Supported API: true

Returns:

ProjectCategory

setCategory

public void setCategory(ProjectCategory a_Category)
                 throws WTPropertyVetoException

Sets the value of the attribute: CATEGORY. the type or category of the project. This category is the same category that is defined in the ProjectTemplate.

Supported API: true

Parameters:

a_Category -

Throws:

WTPropertyVetoException

getProjectNumber

public String getProjectNumber()

Gets the value of the attribute: PROJECT_NUMBER. Identification of the project that is menaingful within the scope of an organization.

Supported API: true

Returns:

String

setProjectNumber

public void setProjectNumber(String a_ProjectNumber)

Sets the value of the attribute: PROJECT_NUMBER. Identification of the project that is menaingful within the scope of an organization.

Supported API: true

Parameters:

a_ProjectNumber -

getBusinessUnit

public String getBusinessUnit()

Gets the value of the attribute: BUSINESS_UNIT. Organizational entity the project is associated with. Each organization has a list of its units.

Supported API: true

Returns:

String

setBusinessUnit

public void setBusinessUnit(String a_BusinessUnit)

Sets the value of the attribute: BUSINESS_UNIT. Organizational entity the project is associated with. Each organization has a list of its units.

Supported API: true

Parameters:

a_BusinessUnit -

getBusinessLocation

public String getBusinessLocation()

Gets the value of the attribute: BUSINESS_LOCATION. Possible sites the project may be associated with. Each organization should have a list of possible business locations.

Supported API: true

Returns:

String

setBusinessLocation

public void setBusinessLocation(String a_BusinessLocation)

Sets the value of the attribute: BUSINESS_LOCATION. Possible sites the project may be associated with. Each organization should have a list of possible business locations.

Supported API: true

Parameters:

a_BusinessLocation -

getBudget

public Currency getBudget()

Gets the value of the attribute: BUDGET. Total amount alloted for the execution of the project.

Supported API: true

Returns:

Currency

setBudget

public void setBudget(Currency a_Budget)

Sets the value of the attribute: BUDGET. Total amount alloted for the execution of the project.

Supported API: true

Parameters:

a_Budget -

getProjectPlan

public ProjectPlan getProjectPlan()
                           throws WTException

Return the ProjectPlan that is associated with this Project2 or null if none exists.

Supported API: true

Returns:

ProjectPlan

Throws:

WTException

isProgram

public static boolean isProgram(WTReference ref)
                         throws WTException

Supported API: true

Parameters:

ref -

Returns:

boolean

Throws:

WTException

isProgram

public boolean isProgram()
                  throws WTException

Supported API: true

Returns:

boolean

Throws:

WTException

getCtmState

public ContainerTeamManagedState getCtmState()

Gets the value of the attribute: CTM_STATE. Enumerated ContainerTeamManagedState value that indicates the current state of the container.

Supported API: true

Specified by:

getCtmState in interface ContainerTeamManaged

Returns:

ContainerTeamManagedState

getInvitationMsg

public String getInvitationMsg()

Gets the value of the attribute: INVITATION_MSG. The body of the email message sent to users who are invited to the container.

Supported API: true

Specified by:

getInvitationMsg in interface ContainerTeamManaged

Returns:

String

setInvitationMsg

public void setInvitationMsg(String a_InvitationMsg)
                      throws WTPropertyVetoException

Sets the value of the attribute: INVITATION_MSG. The body of the email message sent to users who are invited to the container.

Supported API: true

Specified by:

setInvitationMsg in interface ContainerTeamManaged

Parameters:

a_InvitationMsg -

Throws:

WTPropertyVetoException

getCreator

public WTPrincipal getCreator()

Gets the value of the attribute: CREATOR.

Supported API: true

Specified by:

getCreator in interface WTContainer

Returns:

WTPrincipal

setCreator

public void setCreator(WTPrincipal a_Creator)
                throws WTPropertyVetoException,
                       WTException

Sets the value of the attribute: CREATOR.

Supported API: true

Specified by:

setCreator in interface WTContainer

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

WTException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION.

Supported API: true

Specified by:

getDescription in interface WTContainer

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION.

Supported API: true

Specified by:

setDescription in interface WTContainer

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getName

public String getName()

Gets the value of the attribute: NAME. To rename a container, use IdentityHelper.service.changeIdentity(WTContainer, WTContainerIdentity)

Subclasses should override the default implementation of setName to call WTContainerInfo.setName(WTContainer,String). This will ensure the change restriction check is properly enforced.

Supported API: true

Specified by:

getName in interface WTContainer

Returns:

String

See Also:

IdentityService#changeIdentity, WTContainerIdentity

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. To rename a container, use IdentityHelper.service.changeIdentity(WTContainer, WTContainerIdentity)

Subclasses should override the default implementation of setName to call WTContainerInfo.setName(WTContainer,String). This will ensure the change restriction check is properly enforced.

Supported API: true

Specified by:

setName in interface WTContainer

Parameters:

a_Name -

Throws:

WTPropertyVetoException

See Also:

IdentityService#changeIdentity, WTContainerIdentity

getOwner

public WTPrincipal getOwner()

Gets the value of the attribute: OWNER.

Supported API: true

Specified by:

getOwner in interface WTContainer

Returns:

WTPrincipal

setOwner

public void setOwner(WTPrincipal a_Owner)
              throws WTPropertyVetoException,
                     WTException

Sets the value of the attribute: OWNER.

Supported API: true

Specified by:

setOwner in interface WTContainer

Parameters:

a_Owner -

Throws:

WTPropertyVetoException

WTException

isSharingEnabled

public boolean isSharingEnabled()

Gets the value of the attribute: SHARING_ENABLED. Whether or not objects can be shared from this container.

Supported API: true

Specified by:

isSharingEnabled in interface WTContainer

Returns:

boolean

setSharingEnabled

public void setSharingEnabled(boolean a_SharingEnabled)
                       throws WTPropertyVetoException

Sets the value of the attribute: SHARING_ENABLED. Whether or not objects can be shared from this container.

Supported API: true

Specified by:

setSharingEnabled in interface WTContainer

Parameters:

a_SharingEnabled -

Throws:

WTPropertyVetoException

getContainerTemplate

public WTContainerTemplate getContainerTemplate()

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

Supported API: true

Specified by:

getContainerTemplate in interface WTContainer

Returns:

WTContainerTemplate

setContainerTemplate

public void setContainerTemplate(WTContainerTemplate a_ContainerTemplate)
                          throws WTPropertyVetoException,
                                 WTException

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

Supported API: true

Specified by:

setContainerTemplate in interface WTContainer

Parameters:

a_ContainerTemplate -

Throws:

WTPropertyVetoException

WTException

getContainerTemplateReference

public wt.inf.container.WTContainerTemplateRef getContainerTemplateReference()

Gets the value of the attribute: CONTAINER_TEMPLATE_REFERENCE.

Supported API: true

Specified by:

getContainerTemplateReference in interface WTContainer

Returns:

WTContainerTemplateRef

setContainerTemplateReference

public void setContainerTemplateReference(wt.inf.container.WTContainerTemplateRef a_ContainerTemplateReference)
                                   throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_TEMPLATE_REFERENCE.

Supported API: true

Specified by:

setContainerTemplateReference in interface WTContainer

Parameters:

a_ContainerTemplateReference -

Throws:

WTPropertyVetoException

getIdentificationObject

public IdentificationObject getIdentificationObject()
                                             throws WTException

Constructs and returns an identification object. This method is the only way to obtain an identification object.

Supported API: true

Specified by:

getIdentificationObject in interface Identified

Returns:

IdentificationObject

Throws:

WTException

getOrganizationReference

public WTPrincipalReference getOrganizationReference()

Gets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: true

Specified by:

getOrganizationReference in interface OrganizationOwned

Specified by:

getOrganizationReference in interface OrganizationOwnedImpl

Returns:

WTPrincipalReference

setOrganizationReference

public void setOrganizationReference(WTPrincipalReference a_OrganizationReference)
                              throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: true

Parameters:

a_OrganizationReference -

Throws:

WTPropertyVetoException

getOrganizationUniqueIdentifier

public String getOrganizationUniqueIdentifier()

Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER. The getter for this attribute delivers organization unique identifier.

Supported API: true

Specified by:

getOrganizationUniqueIdentifier in interface OrganizationOwned

Returns:

String

getOrganizationCodingSystem

public String getOrganizationCodingSystem()

Gets the value of the attribute: ORGANIZATION_CODING_SYSTEM. The getter for this attribute delivers organization coding system.

Supported API: true

Specified by:

getOrganizationCodingSystem in interface OrganizationOwned

Returns:

String

getOrganizationName

public String getOrganizationName()

Gets the value of the attribute: ORGANIZATION_NAME. The getter for this attribute delivers organization name.

Supported API: true

Specified by:

getOrganizationName in interface OrganizationOwned

Returns:

String

getOrganization

public WTOrganization getOrganization()

Gets the value of the attribute: ORGANIZATION.

Supported API: true

Specified by:

getOrganization in interface OrganizationOwned

Returns:

WTOrganization

setOrganization

public void setOrganization(WTOrganization a_Organization)
                     throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION.

Supported API: true

Parameters:

a_Organization -

Throws:

WTPropertyVetoException