public interface IProjectArea extends IProjectAreaHandle, IProcessArea
ITeamArea
. The
team process that governs the project area can be customized for each team
area by changing the process settings. A description of which settings apply
to a team area is part of the definition of the team process.
Team areas are arranged in one or more trees. A team area inherits its
initial process settings from its parent team area. These inherited settings
can be overridden or be refined. Team areas that do not have parents inherit
the settings of the project area.
In a project area, trees of team areas can be tagged. A team area hierarchy
tag is applied to a team area and automatically includes all of its children.
Project areas must be initialized. After initialization project areas are
fully operational.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEVELOPMENT_LINES_PROPERTY_ID
Id of the development lines property.
|
static java.lang.String |
INITIALIZED_PROPERTY_ID
Id of the initialized property.
|
static IItemType |
ITEM_TYPE
The Project area item type.
|
static java.lang.String |
ITERATION_TYPES_PROPERTY_ID
Id of the iteration types property.
|
static java.lang.String |
PROJECT_DEVELOPMENT_LINE_PROPERTY_ID
Id of the project development line property.
|
static java.lang.String |
PROJECT_LINKS_PROPERTY_ID
Id of the project links property.
|
static java.lang.String |
TEAM_AREA_HIERARCHY_PROPERTY_ID
Id of the team area hierarchy property.
|
ADMINISTRATORS_PROPERTY_ID, ARCHIVED_PROPERTY_ID, MEMBERS_PROPERTY_ID, PROCESS_ATTACHMENTS_PROPERTY_ID, PROCESS_DATA_NAMESPACE_URI, PROCESS_DATA_PROPERTY_ID, PROCESS_DESCRIPTION_PROPERTY_ID, PROJECT_AREA_PROPERTY_ID, TEAM_DATA_PROPERTY_ID
DESCRIPTION_DETAILS_PROPERTY_ID, DESCRIPTION_SUMMARY_PROPERTY_ID, DEVELOPMENT_LINE, ITERATION, ITERATION_TYPE, NAME_PROPERTY_ID, PROCESS_ATTACHMENT, PROCESS_DEFINITION, PROCESS_DOMAIN_DEFINITION, PROJECT_AREA, PROJECT_LINK, READ_ACCESS_LIST, TEAM_AREA
MERGE_PREDECESSOR_STATE_PROPERTY, PREDECESSOR_STATE_PROPERTY
CONTEXT_ID_PROPERTY, ITEM_ID_PROPERTY, MAX_LARGE_STRING_BYTES, MAX_MEDIUM_STRING_BYTES, MAX_SMALL_STRING_BYTES, MODIFIED_BY_PROPERTY, MODIFIED_PROPERTY, STATE_ID_PROPERTY
Modifier and Type | Method and Description |
---|---|
void |
addDevelopmentLine(IDevelopmentLineHandle handle)
Adds the given development line to this project area.
|
void |
addIterationType(IIterationTypeHandle handle)
Adds the given iteration type to this project area.
|
void |
addProjectLink(IProjectLinkHandle link)
Add the project link to this project.
|
IDevelopmentLineHandle[] |
getDevelopmentLines()
Returns the project area's development lines.
|
IIterationTypeHandle[] |
getIterationTypes()
Returns the iteration types defined for this project area.
|
java.lang.String |
getOwningApplicationKey()
get the owningApplicationKey from this project area
|
IProcessDefinitionHandle |
getProcessDefinition()
Returns the definition of the team process governing this project area.
|
IDevelopmentLineHandle |
getProjectDevelopmentLine()
Returns the project development line or
null if this project
area does not have a development that applies to the project area. |
IProjectLinkHandle[] |
getProjectLinks()
Get the project links for this project.
|
IReadAccessListHandle |
getReadAccessList()
Returns this project area's read access list or
null if this
project area has no access list. |
ITeamAreaHierarchy |
getTeamAreaHierarchy()
Returns the team area hierarchy that defines the relationship between the
team areas located inside in this project area.
|
ITeamAreaHierarchy |
getTeamAreaHierarchySnapshot()
Returns a snapshot of team area hierarchy that defines the relationship
between the team areas located inside in this project area.
|
java.util.List |
getTeamAreas()
Returns the list of all team areas located in this project area.
|
boolean |
isInitialized()
Returns whether this project area has been initialized.
|
void |
markInitialized()
Marks this project area as being initialized.
|
void |
removeIterationType(IIterationTypeHandle handle)
Removes the given iteration type from this project area.
|
void |
removeProjectLink(IProjectLinkHandle link)
Remove the project link from this project.
|
void |
setDevelopmentLines(IDevelopmentLineHandle[] handles)
Sets this project area's development lines.
|
void |
setIterationTypes(IIterationTypeHandle[] handles)
Sets this project area's iteration types.
|
void |
setOwningApplicationKey(java.lang.String owningApplicationKey)
set the owningApplicationKey to this project area
|
void |
setProcessDefinition(IProcessDefinitionHandle definition)
Sets the definition of the team process governing this project area.
|
void |
setProjectDevelopmentLine(IDevelopmentLineHandle developmentLine)
Sets this project area's project development line.
|
void |
setProjectLinks(IProjectLinkHandle[] links)
Sets this project's links.
|
addAdministrator, addMember, addRoleAssignments, getAdministrators, getContextId, getMembers, getName, getProcessContentPath, getProcessName, getProcessSummary, getProjectArea, getRoleAssignmentIds, getRoleAssignments, getTeamData, hasAdministrator, hasMember, removeAdministrator, removeAllMembers, removeMember, removeRoleAssignments, setAdministrators, setProcessContentPath, setProcessName, setProcessSummary, setRoleAssignments
addAttachment, getAttachments, getProcessData, isArchived, removeAttachment, setArchived, setAttachments
getProcessItemType, getPropertyName
getDescription, setName
getMergePredecessorState, getPredecessorState
isNewItem
getContextId, getItemHandle, getModifiedBy, getRedactedCopy, getRequestedModified, getRequestedStateId, getStateHandle, getWorkingCopy, hasHistory, isComplete, isPropertySet, isRedactedCopy, isWorkingCopy, modified, setContextId, setRequestedModified, setRequestedStateId
equals, getAdapter, getFullState, getItemId, getItemType, getOrigin, getStateId, hasFullState, hasStateId, isAuditable, isConfigurationAware, isImmutable, isSimple, isUnmanaged, makeImmutable, protect, sameItemId, sameStateId, size
static final IItemType ITEM_TYPE
static final java.lang.String TEAM_AREA_HIERARCHY_PROPERTY_ID
static final java.lang.String DEVELOPMENT_LINES_PROPERTY_ID
static final java.lang.String ITERATION_TYPES_PROPERTY_ID
static final java.lang.String PROJECT_LINKS_PROPERTY_ID
static final java.lang.String INITIALIZED_PROPERTY_ID
static final java.lang.String PROJECT_DEVELOPMENT_LINE_PROPERTY_ID
boolean isInitialized()
markInitialized()
.true
if this project area has been initialized,
false
otherwisevoid markInitialized()
isInitialized()
returns true
.IProcessDefinitionHandle getProcessDefinition()
null
if there is no process
definitionvoid setProcessDefinition(IProcessDefinitionHandle definition)
definition
- the definition of the team process governing this
project areajava.util.List getTeamAreas()
ITeamAreaHandle
)ITeamAreaHierarchy getTeamAreaHierarchy()
ITeamAreaHierarchy getTeamAreaHierarchySnapshot()
IDevelopmentLineHandle[] getDevelopmentLines()
IDevelopmentLineHandle getProjectDevelopmentLine()
null
if this project
area does not have a development that applies to the project area. The
development line returned by this method is included in the set of lines
returned from getDevelopmentLines().
The project development line differs from the project area's other
development lines in that this is the development line that the project
belongs to. All other development lines contain only team areas.null
void setProjectDevelopmentLine(IDevelopmentLineHandle developmentLine)
the
- project development line or null
void addDevelopmentLine(IDevelopmentLineHandle handle)
Note that in order to save the project area, the development line will have to point to this area as its owning project area. When adding a development line to a project area, both items have to be saved together.
handle
- the development line to addvoid setDevelopmentLines(IDevelopmentLineHandle[] handles)
Note that in order to save the project area, the development lines will have to point to this area as their owning project area. When adding development lines to a project area, all items have to be saved together.
handles
- the development linesIIterationTypeHandle[] getIterationTypes()
void setIterationTypes(IIterationTypeHandle[] handles)
handles
- the iteration typesvoid addIterationType(IIterationTypeHandle handle)
handle
- the iteration typevoid removeIterationType(IIterationTypeHandle handle)
handle
- the iteration typeIReadAccessListHandle getReadAccessList()
null
if this
project area has no access list.IProjectLinkHandle[] getProjectLinks()
void addProjectLink(IProjectLinkHandle link)
handle
- the project link to addvoid removeProjectLink(IProjectLinkHandle link)
handle
- the project link to removevoid setProjectLinks(IProjectLinkHandle[] links)
links
- the links to setjava.lang.String getOwningApplicationKey()
void setOwningApplicationKey(java.lang.String owningApplicationKey)
owningApplicationKey
- the owningApplicationKey that will be set to this project area