wt.projmgmt.admin
Class Project2

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

All Implemented Interfaces:

AccessControlled, AccessControlList, AdHocControlled, ContainerTeamManaged, DisplayIdentification, DomainAdministered, Externalizable, Federatable, IBAHolder, Identified, Indexable, NetFactor, ObjectMappable, OrganizationOwned, OrganizationOwnedImpl, Persistable, RecentlyVisited, RemotelyLinkable, Serializable, SubjectOfForum, SubjectOfNotebook, Typed, WTContained, WTContainedIdentified, WTContainer

public class Project2

extends WTObject

implements ContainerTeamManaged, Typed, WTContainer, Indexable, 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

private Currency	budget
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.
private static int	BUSINESS_LOCATION_UPPER_LIMIT
static String	BUSINESS_UNIT Label for the attribute; Organizational entity the project is associated with.
private static int	BUSINESS_UNIT_UPPER_LIMIT
private String	businessLocation
private String	businessUnit
private ProjectCategory	category
static String	CATEGORY Label for the attribute; the type or category of the project.
private static int	CATEGORY_UPPER_LIMIT
private static String	CLASSNAME
static String	COMPLETION_STATUS Label for the attribute; a status value representing the percent complete for the project Supported API: false
private int	completionStatus
static String	CONTAINER Label for the attribute.
static String	CONTAINER_TEMPLATE Label for the attribute.
private WTContainerInfo	containerInfo
private WTContainerRef	containerReference
private ContainerTeamManagedInfo	containerTeamManagedInfo
private WTContainerTemplateRef	containerTemplateReference
private AdminDomainRef	domainRef
private AclEntrySet	entrySet
static String	ESTIMATED_END_DATE Label for the attribute; the estimated end date of the project Supported API: false
private Timestamp	estimatedEndDate
static long	EXTERNALIZATION_VERSION_UID
private FederatableInfo	federatableInfo
static String	HEALTH_STATUS Label for the attribute; the project health status.
private static int	HEALTH_STATUS_UPPER_LIMIT
private ProjectHealthStatus	healthStatus
private IndexerSet	indexerSet
private boolean	inheritedDomain
protected static long	OLD_FORMAT_VERSION_UID
private WTPrincipalReference	organizationReference
private ProjectPhase	phase
static String	PHASE Label for the attribute; the phase of the project object.
private static int	PHASE_UPPER_LIMIT
(package private) ProjectPlan	pplan
static String	PROJECT_NUMBER Label for the attribute; Identification of the project that is menaingful within the scope of an organization.
private static int	PROJECT_NUMBER_UPPER_LIMIT
private String	projectNumber
private static long	R60_EXTERNALIZATION_VERSION_UID
private static long	R62_EXTERNALIZATION_VERSION_UID
private static String	RESOURCE
static String	RISK_DESCRIPTION Label for the attribute; the risk description of the project.
private static int	RISK_DESCRIPTION_UPPER_LIMIT
static String	RISK_VALUE Label for the attribute; the risk value of the project.
private static int	RISK_VALUE_UPPER_LIMIT
private String	riskDescription
private ProjectRiskValue	riskValue
private String	scope
static String	SCOPE Label for the attribute; description of the project scope Supported API: true
private static int	SCOPE_UPPER_LIMIT
(package private) static long	serialVersionUID
private static boolean	SERVER
private WTPrincipalReference	sponsor
static String	SPONSOR Label for the attribute; the owner or sponsor of the project Supported API: false
static String	STATUS_DESCRIPTION Label for the attribute; the status description of the project Supported API: false
private static int	STATUS_DESCRIPTION_UPPER_LIMIT
private String	statusDescription
private AttributeContainer	theAttributeContainer
private TypeDefinitionReference	typeDefinitionReference

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.inf.team.ContainerTeamManaged

ACTIVE_FLAG, ACTUAL_END, ACTUAL_START, ALLOW_USER_TO_CONFIGURE_ACCESS, CONTAINER_TEAM_MANAGED_INFO, CONTAINER_TEAM_REFERENCE, CTM_STATE, INVITATION_MSG, REQUIRE_CONFIRMATION, SEND_INVITATIONS

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.inf.container.WTContainer

ADMINISTRATORS, ADMINISTRATORS_REFERENCE, BUSINESS_NAMESPACE, CONTAINER_INFO, CONTAINER_TEMPLATE_REFERENCE, CONTEXT_PROVIDER, CREATOR, CREATOR_REFERENCE, DEFAULT_CABINET, DEFAULT_CABINET_REFERENCE, DEFAULT_DOMAIN, DEFAULT_DOMAIN_REFERENCE, DESCRIPTION, INTERNET_DOMAIN, META_DATA_NAMESPACE, NAME, OWNER, OWNER_REFERENCE, PRIVATE_ACCESS, PUBLIC_PARENT_DOMAIN, PUBLIC_PARENT_DOMAIN_REFERENCE, SHARING_ENABLED, SYSTEM_CABINET, SYSTEM_CABINET_REFERENCE, SYSTEM_DOMAIN, SYSTEM_DOMAIN_REFERENCE

Fields inherited from interface wt.access.AdHocControlled

ENTRY_SET

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.ufid.Federatable

FEDERATABLE_INFO

Fields inherited from interface wt.inf.container.WTContainedIdentified

CONTAINER_REFERENCE

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME

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

Fields inherited from interface wt.type.Typed

TYPE_DEFINITION_REFERENCE

Fields inherited from interface wt.iba.value.IBAHolder

ATTRIBUTE_CONTAINER

Fields inherited from interface wt.index.Indexable

INDEXER_SET

Constructor Summary

Project2()

Method Summary

private void	containerInfoValidate(WTContainerInfo a_ContainerInfo)
private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
private void	containerTeamManagedInfoValidate(ContainerTeamManagedInfo a_ContainerTeamManagedInfo)
private void	containerTemplateReferenceValidate(WTContainerTemplateRef a_ContainerTemplateReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
private void	federatableInfoValidate(FederatableInfo a_FederatableInfo)
Timestamp	getActualEnd() Gets the value of the attribute: ACTUAL_END.
Timestamp	getActualStart() Gets the value of the attribute: ACTUAL_START.
WTGroup	getAdministrators() Gets the value of the attribute: ADMINISTRATORS.
WTPrincipalReference	getAdministratorsReference() Gets the value of the attribute: ADMINISTRATORS_REFERENCE.
AttributeContainer	getAttributeContainer() Gets the object for the association that plays role: ATTRIBUTE_CONTAINER.
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.
int	getCompletionStatus() Gets the value of the attribute: COMPLETION_STATUS.
String	getConceptualClassname() Deprecated.
WTContainer	getContainer() Gets the object for the association that plays role: CONTAINER.
WTContainerInfo	getContainerInfo() Gets the object for the association that plays role: CONTAINER_INFO.
String	getContainerName() Gets the value of the attribute: CONTAINER_NAME.
WTContainerRef	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
ContainerTeamManagedInfo	getContainerTeamManagedInfo() Gets the object for the association that plays role: CONTAINER_TEAM_MANAGED_INFO.
ContainerTeamReference	getContainerTeamReference() Gets the value of the attribute: CONTAINER_TEAM_REFERENCE.
WTContainerTemplate	getContainerTemplate() Gets the object for the association that plays role: CONTAINER_TEMPLATE.
WTContainerTemplateRef	getContainerTemplateReference() Gets the value of the attribute: CONTAINER_TEMPLATE_REFERENCE.
DirectoryContextProvider	getContextProvider() Gets the value of the attribute: CONTEXT_PROVIDER.
WTPrincipal	getCreator() Gets the value of the attribute: CREATOR.
WTPrincipalReference	getCreatorReference() Gets the value of the attribute: CREATOR_REFERENCE.
ContainerTeamManagedState	getCtmState() Gets the value of the attribute: CTM_STATE.
Cabinet	getDefaultCabinet() Gets the value of the attribute: DEFAULT_CABINET.
CabinetReference	getDefaultCabinetReference() Gets the value of the attribute: DEFAULT_CABINET_REFERENCE.
AdministrativeDomain	getDefaultDomain() Gets the value of the attribute: DEFAULT_DOMAIN.
AdminDomainRef	getDefaultDomainReference() Gets the value of the attribute: DEFAULT_DOMAIN_REFERENCE.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
AdminDomainRef	getDomainRef() Gets the object for the association that plays role: DOMAIN_REF.
AclEntrySet	getEntrySet() Gets the value of the attribute: ENTRY_SET.
Timestamp	getEstimatedEndDate() Gets the value of the attribute: ESTIMATED_END_DATE.
FederatableInfo	getFederatableInfo() Gets the object for the association that plays role: FEDERATABLE_INFO.
ProjectHealthStatus	getHealthStatus() Gets the value of the attribute: HEALTH_STATUS.
IdentificationObject	getIdentificationObject() Constructs and returns an identification object.
String	getIdentity() Gets the value of the attribute: IDENTITY.
IndexerSet	getIndexerSet() Gets the value of the attribute: INDEXER_SET.
String	getInternetDomain() Gets the value of the attribute: INTERNET_DOMAIN.
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.
WTPrincipalReference	getOwnerReference() Gets the value of the attribute: OWNER_REFERENCE.
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.
AdministrativeDomain	getPublicParentDomain() Gets the value of the attribute: PUBLIC_PARENT_DOMAIN.
AdminDomainRef	getPublicParentDomainReference() Gets the value of the attribute: PUBLIC_PARENT_DOMAIN_REFERENCE.
String	getRiskDescription() Gets the value of the attribute: RISK_DESCRIPTION.
ProjectRiskValue	getRiskValue() Gets the value of the attribute: RISK_VALUE.
String	getScope() Gets the value of the attribute: SCOPE.
WTPrincipalReference	getSponsor() Gets the value of the attribute: SPONSOR.
String	getStatusDescription() Gets the value of the attribute: STATUS_DESCRIPTION.
Cabinet	getSystemCabinet() Gets the value of the attribute: SYSTEM_CABINET.
CabinetReference	getSystemCabinetReference() Gets the value of the attribute: SYSTEM_CABINET_REFERENCE.
AdministrativeDomain	getSystemDomain() Gets the value of the attribute: SYSTEM_DOMAIN.
AdminDomainRef	getSystemDomainReference() Gets the value of the attribute: SYSTEM_DOMAIN_REFERENCE.
private WTContainerTemplateRef	getTemplateReference(ObjectInput input)
TypeDefinitionReference	getTypeDefinitionReference() Gets the object for the association that plays role: TYPE_DEFINITION_REFERENCE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Initializes objects created by new-factory methods.
boolean	isActiveFlag() Deprecated. at 7.0
boolean	isAllowUserToConfigureAccess() Gets the value of the attribute: ALLOW_USER_TO_CONFIGURE_ACCESS.
boolean	isBusinessNamespace() Gets the value of the attribute: BUSINESS_NAMESPACE.
boolean	isInheritedDomain() Gets the value of the attribute: INHERITED_DOMAIN.
boolean	isMetaDataNamespace() Gets the value of the attribute: META_DATA_NAMESPACE.
boolean	isPrivateAccess() Gets the value of the attribute: PRIVATE_ACCESS.
boolean	isRequireConfirmation() Gets the value of the attribute: REQUIRE_CONFIRMATION.
boolean	isSendInvitations() Gets the value of the attribute: SEND_INVITATIONS.
boolean	isSharingEnabled() Gets the value of the attribute: SHARING_ENABLED.
static Project2	newProject2() Supported API: false
private void	organizationReferenceValidate(WTPrincipalReference a_OrganizationReference)
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.
private void	readR62Version(ObjectInput input, boolean super_done)
protected boolean	readVersion(Project2 thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	riskDescriptionValidate(String a_RiskDescription)
private void	scopeValidate(String a_Scope)
void	setAdministrators(WTGroup a_Administrators) Sets the value of the attribute: ADMINISTRATORS.
void	setAdministratorsReference(WTPrincipalReference a_AdministratorsReference) Sets the value of the attribute: ADMINISTRATORS_REFERENCE.
void	setAttributeContainer(AttributeContainer a_AttributeContainer) Sets the object for the association that plays role: ATTRIBUTE_CONTAINER.
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.
protected void	setBusinessNamespace(boolean a_BusinessNamespace) Sets the value of the attribute: BUSINESS_NAMESPACE.
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	setCompletionStatus(int a_CompletionStatus) Sets the value of the attribute: COMPLETION_STATUS.
void	setContainer(WTContainer a_Container) Sets the object for the association that plays role: CONTAINER.
protected void	setContainerInfo(WTContainerInfo a_ContainerInfo) Sets the object for the association that plays role: CONTAINER_INFO.
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: CONTAINER_REFERENCE.
void	setContainerTeamManagedInfo(ContainerTeamManagedInfo a_ContainerTeamManagedInfo) Sets the object for the association that plays role: CONTAINER_TEAM_MANAGED_INFO.
void	setContainerTemplate(WTContainerTemplate a_ContainerTemplate) Sets the object for the association that plays role: CONTAINER_TEMPLATE.
void	setContainerTemplateReference(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	setCreatorReference(WTPrincipalReference a_CreatorReference) Sets the value of the attribute: CREATOR_REFERENCE.
void	setDefaultCabinet(Cabinet a_DefaultCabinet) Sets the value of the attribute: DEFAULT_CABINET.
void	setDefaultCabinetReference(CabinetReference a_DefaultCabinetReference) Sets the value of the attribute: DEFAULT_CABINET_REFERENCE.
void	setDefaultDomain(AdministrativeDomain a_DefaultDomain) Sets the value of the attribute: DEFAULT_DOMAIN.
void	setDefaultDomainReference(AdminDomainRef a_DefaultDomainReference) Sets the value of the attribute: DEFAULT_DOMAIN_REFERENCE.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
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	setEstimatedEndDate(Timestamp a_EstimatedEndDate) Sets the value of the attribute: ESTIMATED_END_DATE.
void	setFederatableInfo(FederatableInfo a_FederatableInfo) Sets the object for the association that plays role: FEDERATABLE_INFO.
void	setHealthStatus(ProjectHealthStatus a_HealthStatus) Sets the value of the attribute: HEALTH_STATUS.
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	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	setOwnerReference(WTPrincipalReference a_OwnerReference) Sets the value of the attribute: OWNER_REFERENCE.
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	setRiskDescription(String a_RiskDescription) Sets the value of the attribute: RISK_DESCRIPTION.
void	setRiskValue(ProjectRiskValue a_RiskValue) Sets the value of the attribute: RISK_VALUE.
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.
void	setSponsor(WTPrincipalReference a_Sponsor) Sets the value of the attribute: SPONSOR.
void	setStatusDescription(String a_StatusDescription) Sets the value of the attribute: STATUS_DESCRIPTION.
void	setSystemCabinet(Cabinet a_SystemCabinet) Sets the value of the attribute: SYSTEM_CABINET.
void	setSystemCabinetReference(CabinetReference a_SystemCabinetReference) Sets the value of the attribute: SYSTEM_CABINET_REFERENCE.
void	setSystemDomain(AdministrativeDomain a_SystemDomain) Sets the value of the attribute: SYSTEM_DOMAIN.
void	setSystemDomainReference(AdminDomainRef a_SystemDomainReference) Sets the value of the attribute: SYSTEM_DOMAIN_REFERENCE.
void	setTransientCachedPlan(ProjectPlan aplan)
void	setTypeDefinitionReference(TypeDefinitionReference a_TypeDefinitionReference) Sets the object for the association that plays role: TYPE_DEFINITION_REFERENCE.
private void	sponsorValidate(WTPrincipalReference a_Sponsor)
private void	statusDescriptionValidate(String a_StatusDescription)
private void	typeDefinitionReferenceValidate(TypeDefinitionReference a_TypeDefinitionReference)
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.Persistable

checkAttributes, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Methods inherited from interface wt.identity.DisplayIdentification

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

SCOPE

public static final String SCOPE

Label for the attribute; description of the project scope

Supported API: true

See Also:

Constant Field Values

SCOPE_UPPER_LIMIT

private static int SCOPE_UPPER_LIMIT

scope

private String scope

SPONSOR

public static final String SPONSOR

Label for the attribute; the owner or sponsor of the project

Supported API: false

See Also:

Constant Field Values

sponsor

private WTPrincipalReference sponsor

ESTIMATED_END_DATE

public static final String ESTIMATED_END_DATE

Label for the attribute; the estimated end date of the project

Supported API: false

See Also:

Constant Field Values

estimatedEndDate

private Timestamp estimatedEndDate

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

PHASE_UPPER_LIMIT

private static int PHASE_UPPER_LIMIT

phase

private ProjectPhase phase

COMPLETION_STATUS

public static final String COMPLETION_STATUS

Label for the attribute; a status value representing the percent complete for the project

Supported API: false

See Also:

Constant Field Values

completionStatus

private int completionStatus

STATUS_DESCRIPTION

public static final String STATUS_DESCRIPTION

Label for the attribute; the status description of the project

Supported API: false

See Also:

Constant Field Values

STATUS_DESCRIPTION_UPPER_LIMIT

private static int STATUS_DESCRIPTION_UPPER_LIMIT

statusDescription

private String statusDescription

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

HEALTH_STATUS_UPPER_LIMIT

private static int HEALTH_STATUS_UPPER_LIMIT

healthStatus

private ProjectHealthStatus healthStatus

RISK_VALUE

public static final String RISK_VALUE

Label for the attribute; the risk value of the project. Examples include: Very High, High, Medium, Low, Very Low.

Supported API: false

See Also:

Constant Field Values

RISK_VALUE_UPPER_LIMIT

private static int RISK_VALUE_UPPER_LIMIT

riskValue

private ProjectRiskValue riskValue

RISK_DESCRIPTION

public static final String RISK_DESCRIPTION

Label for the attribute; the risk description of the project.

Supported API: false

See Also:

Constant Field Values

RISK_DESCRIPTION_UPPER_LIMIT

private static int RISK_DESCRIPTION_UPPER_LIMIT

riskDescription

private String riskDescription

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

CATEGORY_UPPER_LIMIT

private static int CATEGORY_UPPER_LIMIT

category

private ProjectCategory category

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

PROJECT_NUMBER_UPPER_LIMIT

private static int PROJECT_NUMBER_UPPER_LIMIT

projectNumber

private String projectNumber

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_UNIT_UPPER_LIMIT

private static int BUSINESS_UNIT_UPPER_LIMIT

businessUnit

private String businessUnit

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

BUSINESS_LOCATION_UPPER_LIMIT

private static int BUSINESS_LOCATION_UPPER_LIMIT

businessLocation

private String businessLocation

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

budget

private Currency budget

containerTeamManagedInfo

private ContainerTeamManagedInfo containerTeamManagedInfo

containerInfo

private WTContainerInfo containerInfo

CONTAINER_TEMPLATE

public static final String CONTAINER_TEMPLATE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

containerTemplateReference

private WTContainerTemplateRef containerTemplateReference

entrySet

private AclEntrySet entrySet

inheritedDomain

private boolean inheritedDomain

domainRef

private AdminDomainRef domainRef

federatableInfo

private FederatableInfo federatableInfo

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerReference

private WTContainerRef containerReference

organizationReference

private WTPrincipalReference organizationReference

typeDefinitionReference

private TypeDefinitionReference typeDefinitionReference

theAttributeContainer

private AttributeContainer theAttributeContainer

indexerSet

private IndexerSet indexerSet

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

R62_EXTERNALIZATION_VERSION_UID

private static final long R62_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

R60_EXTERNALIZATION_VERSION_UID

private static final long R60_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

pplan

transient ProjectPlan pplan

SERVER

private static final boolean SERVER

Constructor Detail

Project2

public Project2()

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(Project2 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

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

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

scopeValidate

private void scopeValidate(String a_Scope)
                    throws WTPropertyVetoException

Parameters:

a_Scope -

Throws:

WTPropertyVetoException

getSponsor

public WTPrincipalReference getSponsor()

Gets the value of the attribute: SPONSOR. the owner or sponsor of the project

Supported API: false

Returns:

WTPrincipalReference

setSponsor

public void setSponsor(WTPrincipalReference a_Sponsor)
                throws WTPropertyVetoException

Sets the value of the attribute: SPONSOR. the owner or sponsor of the project

Supported API: false

Parameters:

a_Sponsor -

Throws:

WTPropertyVetoException

sponsorValidate

private void sponsorValidate(WTPrincipalReference a_Sponsor)
                      throws WTPropertyVetoException

Parameters:

a_Sponsor -

Throws:

WTPropertyVetoException

getEstimatedEndDate

public Timestamp getEstimatedEndDate()

Gets the value of the attribute: ESTIMATED_END_DATE. the estimated end date of the project

Supported API: false

Returns:

Timestamp

setEstimatedEndDate

public void setEstimatedEndDate(Timestamp a_EstimatedEndDate)
                         throws WTPropertyVetoException

Sets the value of the attribute: ESTIMATED_END_DATE. the estimated end date of the project

Supported API: false

Parameters:

a_EstimatedEndDate -

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

getCompletionStatus

public int getCompletionStatus()

Gets the value of the attribute: COMPLETION_STATUS. a status value representing the percent complete for the project

Supported API: false

Returns:

int

setCompletionStatus

public void setCompletionStatus(int a_CompletionStatus)
                         throws WTPropertyVetoException

Sets the value of the attribute: COMPLETION_STATUS. a status value representing the percent complete for the project

Supported API: false

Parameters:

a_CompletionStatus -

Throws:

WTPropertyVetoException

getStatusDescription

public String getStatusDescription()

Gets the value of the attribute: STATUS_DESCRIPTION. the status description of the project

Supported API: false

Returns:

String

setStatusDescription

public void setStatusDescription(String a_StatusDescription)
                          throws WTPropertyVetoException

Sets the value of the attribute: STATUS_DESCRIPTION. the status description of the project

Supported API: false

Parameters:

a_StatusDescription -

Throws:

WTPropertyVetoException

statusDescriptionValidate

private void statusDescriptionValidate(String a_StatusDescription)
                                throws WTPropertyVetoException

Parameters:

a_StatusDescription -

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

getRiskValue

public ProjectRiskValue getRiskValue()

Gets the value of the attribute: RISK_VALUE. the risk value of the project. Examples include: Very High, High, Medium, Low, Very Low.

Supported API: false

Returns:

ProjectRiskValue

setRiskValue

public void setRiskValue(ProjectRiskValue a_RiskValue)
                  throws WTPropertyVetoException

Sets the value of the attribute: RISK_VALUE. the risk value of the project. Examples include: Very High, High, Medium, Low, Very Low.

Supported API: false

Parameters:

a_RiskValue -

Throws:

WTPropertyVetoException

getRiskDescription

public String getRiskDescription()

Gets the value of the attribute: RISK_DESCRIPTION. the risk description of the project.

Supported API: false

Returns:

String

setRiskDescription

public void setRiskDescription(String a_RiskDescription)
                        throws WTPropertyVetoException

Sets the value of the attribute: RISK_DESCRIPTION. the risk description of the project.

Supported API: false

Parameters:

a_RiskDescription -

Throws:

WTPropertyVetoException

riskDescriptionValidate

private void riskDescriptionValidate(String a_RiskDescription)
                              throws WTPropertyVetoException

Parameters:

a_RiskDescription -

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 -

newProject2

public static Project2 newProject2()
                            throws WTException

Supported API: false

Returns:

Project2

Throws:

WTException

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

initialize

protected void initialize()
                   throws WTException

Initializes objects created by new-factory methods.

Supported API: false

Overrides:

initialize in class WTObject

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

isRequireConfirmation

public boolean isRequireConfirmation()

Gets the value of the attribute: REQUIRE_CONFIRMATION.

Supported API: false

Specified by:

isRequireConfirmation in interface ContainerTeamManaged

Returns:

boolean

isSendInvitations

public boolean isSendInvitations()

Gets the value of the attribute: SEND_INVITATIONS.

Supported API: false

Specified by:

isSendInvitations in interface ContainerTeamManaged

Returns:

boolean

isAllowUserToConfigureAccess

public boolean isAllowUserToConfigureAccess()

Gets the value of the attribute: ALLOW_USER_TO_CONFIGURE_ACCESS.

Supported API: false

Specified by:

isAllowUserToConfigureAccess in interface ContainerTeamManaged

Returns:

boolean

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

isActiveFlag

public boolean isActiveFlag()

Deprecated. at 7.0

Gets the value of the attribute: ACTIVE_FLAG.

Supported API: false

Specified by:

isActiveFlag in interface ContainerTeamManaged

Returns:

boolean

getActualStart

public Timestamp getActualStart()

Gets the value of the attribute: ACTUAL_START.

Supported API: false

Specified by:

getActualStart in interface ContainerTeamManaged

Returns:

Timestamp

getActualEnd

public Timestamp getActualEnd()

Gets the value of the attribute: ACTUAL_END.

Supported API: false

Specified by:

getActualEnd in interface ContainerTeamManaged

Returns:

Timestamp

getContainerTeamReference

public ContainerTeamReference getContainerTeamReference()

Gets the value of the attribute: CONTAINER_TEAM_REFERENCE. the ContainerTeam of the ContainerTeamManaged object (a derived attribute)

Supported API: false

Specified by:

getContainerTeamReference in interface ContainerTeamManaged

Returns:

ContainerTeamReference

getContainerTeamManagedInfo

public ContainerTeamManagedInfo getContainerTeamManagedInfo()

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

Supported API: false

Specified by:

getContainerTeamManagedInfo in interface ContainerTeamManaged

Returns:

ContainerTeamManagedInfo

setContainerTeamManagedInfo

public void setContainerTeamManagedInfo(ContainerTeamManagedInfo a_ContainerTeamManagedInfo)
                                 throws WTPropertyVetoException

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

Supported API: false

Specified by:

setContainerTeamManagedInfo in interface ContainerTeamManaged

Parameters:

a_ContainerTeamManagedInfo -

Throws:

WTPropertyVetoException

containerTeamManagedInfoValidate

private void containerTeamManagedInfoValidate(ContainerTeamManagedInfo a_ContainerTeamManagedInfo)
                                       throws WTPropertyVetoException

Parameters:

a_ContainerTeamManagedInfo -

Throws:

WTPropertyVetoException

getAdministrators

public WTGroup getAdministrators()

Gets the value of the attribute: ADMINISTRATORS. Used by the WTContainerService.isAsministrator API to determine if a given user is an administrator of a container.

Supported API: false

Specified by:

getAdministrators in interface WTContainer

Returns:

WTGroup

setAdministrators

public void setAdministrators(WTGroup a_Administrators)
                       throws WTPropertyVetoException,
                              WTException

Sets the value of the attribute: ADMINISTRATORS. Used by the WTContainerService.isAsministrator API to determine if a given user is an administrator of a container.

Supported API: false

Specified by:

setAdministrators in interface WTContainer

Parameters:

a_Administrators -

Throws:

WTPropertyVetoException

WTException

getAdministratorsReference

public WTPrincipalReference getAdministratorsReference()

Gets the value of the attribute: ADMINISTRATORS_REFERENCE.

Supported API: false

Specified by:

getAdministratorsReference in interface WTContainer

Returns:

WTPrincipalReference

See Also:

#administrators

setAdministratorsReference

public void setAdministratorsReference(WTPrincipalReference a_AdministratorsReference)
                                throws WTPropertyVetoException

Sets the value of the attribute: ADMINISTRATORS_REFERENCE.

Supported API: false

Specified by:

setAdministratorsReference in interface WTContainer

Parameters:

a_AdministratorsReference -

Throws:

WTPropertyVetoException

See Also:

#administrators

isBusinessNamespace

public boolean isBusinessNamespace()

Gets the value of the attribute: BUSINESS_NAMESPACE. Whether or not objects in the "business namespace" have their identity constrained by this container. If false, then the first parent of this container that is a business namespace will be used.

Supported API: false

Specified by:

isBusinessNamespace in interface WTContainer

Returns:

boolean

setBusinessNamespace

protected void setBusinessNamespace(boolean a_BusinessNamespace)
                             throws WTPropertyVetoException

Sets the value of the attribute: BUSINESS_NAMESPACE. Whether or not objects in the "business namespace" have their identity constrained by this container. If false, then the first parent of this container that is a business namespace will be used.

Supported API: false

Parameters:

a_BusinessNamespace -

Throws:

WTPropertyVetoException

getContextProvider

public DirectoryContextProvider getContextProvider()
                                            throws WTException

Gets the value of the attribute: CONTEXT_PROVIDER. Represents a node in LDAP under which container-specific LDAP objects should be created.

Supported API: false

Specified by:

getContextProvider in interface WTContainer

Returns:

DirectoryContextProvider

Throws:

WTException

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

getCreatorReference

public WTPrincipalReference getCreatorReference()

Gets the value of the attribute: CREATOR_REFERENCE.

Supported API: false

Specified by:

getCreatorReference in interface WTContainer

Returns:

WTPrincipalReference

setCreatorReference

public void setCreatorReference(WTPrincipalReference a_CreatorReference)
                         throws WTPropertyVetoException

Sets the value of the attribute: CREATOR_REFERENCE.

Supported API: false

Specified by:

setCreatorReference in interface WTContainer

Parameters:

a_CreatorReference -

Throws:

WTPropertyVetoException

getDefaultCabinet

public Cabinet getDefaultCabinet()

Gets the value of the attribute: DEFAULT_CABINET. A Cabinet for a container's "business" data. Typically, folder browsing will use the default cabinet as a root. Administrative data should be placed in the system cabinet.

Every effort should be made to limit the Cabinets in a container to the 2 defined in the WTContainer model -- the defaultCabinet and systemCabinet.

Supported API: false

Specified by:

getDefaultCabinet in interface WTContainer

Returns:

Cabinet

setDefaultCabinet

public void setDefaultCabinet(Cabinet a_DefaultCabinet)
                       throws WTPropertyVetoException,
                              WTException

Sets the value of the attribute: DEFAULT_CABINET. A Cabinet for a container's "business" data. Typically, folder browsing will use the default cabinet as a root. Administrative data should be placed in the system cabinet.

Every effort should be made to limit the Cabinets in a container to the 2 defined in the WTContainer model -- the defaultCabinet and systemCabinet.

Supported API: false

Specified by:

setDefaultCabinet in interface WTContainer

Parameters:

a_DefaultCabinet -

Throws:

WTPropertyVetoException

WTException

getDefaultCabinetReference

public CabinetReference getDefaultCabinetReference()

Gets the value of the attribute: DEFAULT_CABINET_REFERENCE.

Supported API: false

Specified by:

getDefaultCabinetReference in interface WTContainer

Returns:

CabinetReference

See Also:

#cabinet

setDefaultCabinetReference

public void setDefaultCabinetReference(CabinetReference a_DefaultCabinetReference)
                                throws WTPropertyVetoException

Sets the value of the attribute: DEFAULT_CABINET_REFERENCE.

Supported API: false

Specified by:

setDefaultCabinetReference in interface WTContainer

Parameters:

a_DefaultCabinetReference -

Throws:

WTPropertyVetoException

See Also:

#cabinet

getDefaultDomain

public AdministrativeDomain getDefaultDomain()

Gets the value of the attribute: DEFAULT_DOMAIN. A domain that is set up to administer a container's business data. If this container is not private, then the default domain will be parented by the publicParentDomain.

Supported API: false

Specified by:

getDefaultDomain in interface WTContainer

Returns:

AdministrativeDomain

setDefaultDomain

public void setDefaultDomain(AdministrativeDomain a_DefaultDomain)
                      throws WTPropertyVetoException,
                             WTException

Sets the value of the attribute: DEFAULT_DOMAIN. A domain that is set up to administer a container's business data. If this container is not private, then the default domain will be parented by the publicParentDomain.

Supported API: false

Specified by:

setDefaultDomain in interface WTContainer

Parameters:

a_DefaultDomain -

Throws:

WTPropertyVetoException

WTException

getDefaultDomainReference

public AdminDomainRef getDefaultDomainReference()

Gets the value of the attribute: DEFAULT_DOMAIN_REFERENCE.

Supported API: false

Specified by:

getDefaultDomainReference in interface WTContainer

Returns:

AdminDomainRef

See Also:

#defaultDomain

setDefaultDomainReference

public void setDefaultDomainReference(AdminDomainRef a_DefaultDomainReference)
                               throws WTPropertyVetoException

Sets the value of the attribute: DEFAULT_DOMAIN_REFERENCE.

Supported API: false

Specified by:

setDefaultDomainReference in interface WTContainer

Parameters:

a_DefaultDomainReference -

Throws:

WTPropertyVetoException

See Also:

#defaultDomain

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

getInternetDomain

public String getInternetDomain()
                         throws WTException

Gets the value of the attribute: INTERNET_DOMAIN. The name of the internet domain associated with this container, for example "com.ptc".

This property is derived from WTOrganization.internetDomain

Supported API: false

Specified by:

getInternetDomain in interface WTContainer

Returns:

String

Throws:

WTException

isMetaDataNamespace

public boolean isMetaDataNamespace()

Gets the value of the attribute: META_DATA_NAMESPACE. Determines whether or not this container can have LWC metadata dependent upon it. If true, then getInternetDomain() must return a non-null value.

This property will always be true for instances of OrgContainer or ExchangeContainer, and always be false for other container types.

Supported API: false

Specified by:

isMetaDataNamespace in interface WTContainer

Returns:

boolean

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

getOwnerReference

public WTPrincipalReference getOwnerReference()

Gets the value of the attribute: OWNER_REFERENCE.

Supported API: false

Specified by:

getOwnerReference in interface WTContainer

Returns:

WTPrincipalReference

See Also:

#owner

setOwnerReference

public void setOwnerReference(WTPrincipalReference a_OwnerReference)
                       throws WTPropertyVetoException

Sets the value of the attribute: OWNER_REFERENCE.

Supported API: false

Specified by:

setOwnerReference in interface WTContainer

Parameters:

a_OwnerReference -

Throws:

WTPropertyVetoException

See Also:

#owner

isPrivateAccess

public boolean isPrivateAccess()

Gets the value of the attribute: PRIVATE_ACCESS. Determines how open the access is to the contents of this container. When true, the container should be set up such that only the users directly participating in the container have access to it. For ContainerTeamManaged objects, this means the confirmed participants in the container.

If a container has already been run through the create process, then the WTContainerService should be used to change this property. Use makePrivate to turn on private access, and makePublic to turn it off.

Supported API: false

Specified by:

isPrivateAccess in interface WTContainer

Returns:

boolean

getPublicParentDomain

public AdministrativeDomain getPublicParentDomain()

Gets the value of the attribute: PUBLIC_PARENT_DOMAIN.

Supported API: false

Specified by:

getPublicParentDomain in interface WTContainer

Returns:

AdministrativeDomain

getPublicParentDomainReference

public AdminDomainRef getPublicParentDomainReference()

Gets the value of the attribute: PUBLIC_PARENT_DOMAIN_REFERENCE.

Supported API: false

Specified by:

getPublicParentDomainReference in interface WTContainer

Returns:

AdminDomainRef

See Also:

#publicParentDomain

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

getSystemCabinet

public Cabinet getSystemCabinet()

Gets the value of the attribute: SYSTEM_CABINET. A Cabinet for "system" data. The assumption is that data in this cabinet is typically not displayed in a folder paradigm but rather through another administrative client. Typical folder displays should work with the defaultCabinet.

Every effort should be made to limit the Cabinets in a container to the 2 defined in the WTContainer model -- the defaultCabinet and systemCabinet.

Supported API: false

Specified by:

getSystemCabinet in interface WTContainer

Returns:

Cabinet

setSystemCabinet

public void setSystemCabinet(Cabinet a_SystemCabinet)
                      throws WTPropertyVetoException,
                             WTException

Sets the value of the attribute: SYSTEM_CABINET. A Cabinet for "system" data. The assumption is that data in this cabinet is typically not displayed in a folder paradigm but rather through another administrative client. Typical folder displays should work with the defaultCabinet.

Every effort should be made to limit the Cabinets in a container to the 2 defined in the WTContainer model -- the defaultCabinet and systemCabinet.

Supported API: false

Specified by:

setSystemCabinet in interface WTContainer

Parameters:

a_SystemCabinet -

Throws:

WTPropertyVetoException

WTException

getSystemCabinetReference

public CabinetReference getSystemCabinetReference()

Gets the value of the attribute: SYSTEM_CABINET_REFERENCE.

Supported API: false

Specified by:

getSystemCabinetReference in interface WTContainer

Returns:

CabinetReference

See Also:

#systemCabinet

setSystemCabinetReference

public void setSystemCabinetReference(CabinetReference a_SystemCabinetReference)
                               throws WTPropertyVetoException

Sets the value of the attribute: SYSTEM_CABINET_REFERENCE.

Supported API: false

Specified by:

setSystemCabinetReference in interface WTContainer

Parameters:

a_SystemCabinetReference -

Throws:

WTPropertyVetoException

See Also:

#systemCabinet

getSystemDomain

public AdministrativeDomain getSystemDomain()

Gets the value of the attribute: SYSTEM_DOMAIN. A domain that is set up to administer a container's system data. Care should be taken when specifying the parent of the systemDomain, so that open access is not granted to the container's administrative data.

Supported API: false

Specified by:

getSystemDomain in interface WTContainer

Returns:

AdministrativeDomain

setSystemDomain

public void setSystemDomain(AdministrativeDomain a_SystemDomain)
                     throws WTPropertyVetoException,
                            WTException

Sets the value of the attribute: SYSTEM_DOMAIN. A domain that is set up to administer a container's system data. Care should be taken when specifying the parent of the systemDomain, so that open access is not granted to the container's administrative data.

Supported API: false

Specified by:

setSystemDomain in interface WTContainer

Parameters:

a_SystemDomain -

Throws:

WTPropertyVetoException

WTException

getSystemDomainReference

public AdminDomainRef getSystemDomainReference()

Gets the value of the attribute: SYSTEM_DOMAIN_REFERENCE.

Supported API: false

Specified by:

getSystemDomainReference in interface WTContainer

Returns:

AdminDomainRef

See Also:

#systemDomain

setSystemDomainReference

public void setSystemDomainReference(AdminDomainRef a_SystemDomainReference)
                              throws WTPropertyVetoException

Sets the value of the attribute: SYSTEM_DOMAIN_REFERENCE.

Supported API: false

Specified by:

setSystemDomainReference in interface WTContainer

Parameters:

a_SystemDomainReference -

Throws:

WTPropertyVetoException

See Also:

#systemDomain

getContainerInfo

public WTContainerInfo getContainerInfo()

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

Supported API: false

Specified by:

getContainerInfo in interface WTContainer

Returns:

WTContainerInfo

setContainerInfo

protected void setContainerInfo(WTContainerInfo a_ContainerInfo)
                         throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_ContainerInfo -

Throws:

WTPropertyVetoException

containerInfoValidate

private void containerInfoValidate(WTContainerInfo a_ContainerInfo)
                            throws WTPropertyVetoException

Parameters:

a_ContainerInfo -

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 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(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

containerTemplateReferenceValidate

private void containerTemplateReferenceValidate(WTContainerTemplateRef a_ContainerTemplateReference)
                                         throws WTPropertyVetoException

Parameters:

a_ContainerTemplateReference -

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 -

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 -

getFederatableInfo

public FederatableInfo getFederatableInfo()

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

Supported API: false

Specified by:

getFederatableInfo in interface Federatable

Returns:

FederatableInfo

setFederatableInfo

public void setFederatableInfo(FederatableInfo a_FederatableInfo)
                        throws WTPropertyVetoException

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

Supported API: false

Specified by:

setFederatableInfo in interface Federatable

Parameters:

a_FederatableInfo -

Throws:

WTPropertyVetoException

federatableInfoValidate

private void federatableInfoValidate(FederatableInfo a_FederatableInfo)
                              throws WTPropertyVetoException

Parameters:

a_FederatableInfo -

Throws:

WTPropertyVetoException

getContainer

public WTContainer getContainer()

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

Supported API: false

Specified by:

getContainer in interface WTContainedIdentified

Returns:

WTContainer

setContainer

public void setContainer(WTContainer a_Container)
                  throws WTPropertyVetoException,
                         WTException

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

Supported API: false

Specified by:

setContainer in interface WTContainedIdentified

Parameters:

a_Container -

Throws:

WTPropertyVetoException

WTException

getContainerReference

public WTContainerRef getContainerReference()

Gets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

getContainerReference in interface WTContainedIdentified

Returns:

WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

setContainerReference in interface WTContainedIdentified

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

getContainerName

public String getContainerName()

Gets the value of the attribute: CONTAINER_NAME. The name of the WTContainer this object is assigned to.

Supported API: false

Specified by:

getContainerName in interface WTContained

Returns:

String

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: false

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: false

Specified by:

setOrganizationReference in interface OrganizationOwnedImpl

Parameters:

a_OrganizationReference -

Throws:

WTPropertyVetoException

organizationReferenceValidate

private void organizationReferenceValidate(WTPrincipalReference a_OrganizationReference)
                                    throws WTPropertyVetoException

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

Specified by:

setOrganization in interface OrganizationOwned

Parameters:

a_Organization -

Throws:

WTPropertyVetoException

getTypeDefinitionReference

public TypeDefinitionReference getTypeDefinitionReference()

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

Supported API: false

Specified by:

getTypeDefinitionReference in interface Typed

Returns:

TypeDefinitionReference

setTypeDefinitionReference

public void setTypeDefinitionReference(TypeDefinitionReference a_TypeDefinitionReference)
                                throws WTPropertyVetoException

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

Supported API: false

Specified by:

setTypeDefinitionReference in interface Typed

Parameters:

a_TypeDefinitionReference -

Throws:

WTPropertyVetoException

typeDefinitionReferenceValidate

private void typeDefinitionReferenceValidate(TypeDefinitionReference a_TypeDefinitionReference)
                                      throws WTPropertyVetoException

Parameters:

a_TypeDefinitionReference -

Throws:

WTPropertyVetoException

getAttributeContainer

public AttributeContainer getAttributeContainer()

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

Supported API: false

Specified by:

getAttributeContainer in interface IBAHolder

Returns:

AttributeContainer

setAttributeContainer

public void setAttributeContainer(AttributeContainer a_AttributeContainer)

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

Supported API: false

Specified by:

setAttributeContainer in interface IBAHolder

Parameters:

a_AttributeContainer -

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 -

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

readR62Version

private void readR62Version(ObjectInput input,
                            boolean super_done)
                     throws IOException,
                            ClassNotFoundException

Throws:

IOException

ClassNotFoundException

getTemplateReference

private WTContainerTemplateRef getTemplateReference(ObjectInput input)
                                             throws WTException,
                                                    IOException,
                                                    ClassNotFoundException

Throws:

WTException

IOException

ClassNotFoundException

setTransientCachedPlan

public void setTransientCachedPlan(ProjectPlan aplan)

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 WTObject

Returns:

String