public interface IProcessArea extends IProcessAreaHandle, IProcessContainer, org.eclipse.core.runtime.IAdaptable
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ADMINISTRATORS_PROPERTY_ID
Id of the administrators property.
|
static java.lang.String |
ARCHIVED_PROPERTY_ID
Id of the archived property.
|
static IItemType |
ITEM_TYPE
The process area item type.
|
static java.lang.String |
MEMBERS_PROPERTY_ID
Id of the members property.
|
static java.lang.String |
PROCESS_ATTACHMENTS_PROPERTY_ID
Id of the process attachments property.
|
static java.lang.String |
PROCESS_DATA_NAMESPACE_URI
URI for the name space of the process data.
|
static java.lang.String |
PROCESS_DATA_PROPERTY_ID
Id of the process data property.
|
static java.lang.String |
PROCESS_DESCRIPTION_PROPERTY_ID
Id of the process description property.
|
static java.lang.String |
PROJECT_AREA_PROPERTY_ID
Id of the 'project area' property.
|
static java.lang.String |
TEAM_DATA_PROPERTY_ID
Id of the team data property.
|
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 |
addAdministrator(IContributorHandle contributorHandle)
Adds the contributor represented by the given handle to the set of
contributors constituting the administrators of this process area.
|
void |
addMember(IContributorHandle contributorHandle)
Adds the contributor represented by the given handle to the set of
contributors constituting the members of this process area.
|
void |
addRoleAssignments(IContributorHandle contributor,
IRole[] roles)
Appends the given roles to the collection of roles assigned to the given
contributor.
|
IContributorHandle[] |
getAdministrators()
Returns the collection of users who are responsible for administering the
process area.
|
UUID |
getContextId(IAccessGroup.ReadAccessContextType contextType)
Retrieves the context id for the specified read access context type.
|
IContributorHandle[] |
getMembers()
Returns an array of handles representing the contributors constituting
the team members of this process area.
|
java.lang.String |
getName()
Returns the name of this area.
|
java.lang.String |
getProcessContentPath()
Returns the path of the home page of the process contents associated with
this process area or
null if none has been set. |
java.lang.String |
getProcessName()
Returns the name of this process area's process or
null if
no name has been set. |
java.lang.String |
getProcessSummary()
Returns the summary of this process area's process or
null
if no summary has been set. |
IProjectAreaHandle |
getProjectArea()
Returns a handle to the project area which contains this process area or
null . |
java.lang.String[] |
getRoleAssignmentIds(IContributorHandle contributor)
Returns the collection of role ids which are assigned to the given
contributor in this process area.
|
IRole[] |
getRoleAssignments(IContributorHandle contributor,
IRole[] availableRoles)
Returns the subset of the given collection of available roles which are
assigned to the given contributor in this process area.
|
ITeamData |
getTeamData()
Returns the team data associated with the process area.
|
boolean |
hasAdministrator(IContributorHandle contributorHandle)
Returns
true if the contributor represented by the given
handle is an administrator of this team, false otherwise. |
boolean |
hasMember(IContributorHandle contributorHandle)
Returns
true if the contributor represented by the given
handle is a member of this team, false otherwise. |
void |
removeAdministrator(IContributorHandle contributorHandle)
Removes the contributor represented by the given handle from the set of
contributors constituting the administrators of this process area.
|
void |
removeAllMembers()
Removes all contributors from this team area.
|
void |
removeMember(IContributorHandle contributorHandle)
Removes the contributor represented by the given handle from the set of
contributors constituting the members of this process area.
|
void |
removeRoleAssignments(IContributorHandle contributor,
IRole[] rolesToRemove)
Removes the given roles from the collection of roles assigned to the
given contributor.
|
void |
setAdministrators(IContributorHandle[] administrators)
Sets the collection of users who are responsible for administering the
process area.
|
void |
setProcessContentPath(java.lang.String contentPath)
Sets the path of the homepage within the process contents archive file
associated with this process area.
|
void |
setProcessName(java.lang.String name)
Sets the name of this process area's process.
|
void |
setProcessSummary(java.lang.String summary)
Sets the summary of this process area's process.
|
void |
setRoleAssignments(IContributorHandle contributor,
IRole[] roles)
Sets the collection of roles assigned to the given contributor.
|
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 PROCESS_DATA_NAMESPACE_URI
static final java.lang.String PROCESS_DATA_PROPERTY_ID
static final java.lang.String PROCESS_ATTACHMENTS_PROPERTY_ID
static final java.lang.String TEAM_DATA_PROPERTY_ID
static final java.lang.String MEMBERS_PROPERTY_ID
static final java.lang.String ADMINISTRATORS_PROPERTY_ID
static final java.lang.String PROCESS_DESCRIPTION_PROPERTY_ID
static final java.lang.String ARCHIVED_PROPERTY_ID
static final java.lang.String PROJECT_AREA_PROPERTY_ID
java.lang.String getName()
In order for this item to be saved to the repository this field must have
a non-null value, so it is safe to assume that this method will not
return null if it is an immutable copy fetched from the repository. It is
possible for an incomplete/invalid working copy, however, to return
null
.
getName
in interface INamed
null
INamed.getName()
IContributorHandle[] getMembers()
boolean hasMember(IContributorHandle contributorHandle)
true
if the contributor represented by the given
handle is a member of this team, false
otherwise.contributorHandle
- a handle to the contributor for which to check
membershiptrue
if the contributor is a member,
false
otherwisevoid addMember(IContributorHandle contributorHandle)
contributorHandle
- a handle to the contributor to be added to the
process areavoid removeMember(IContributorHandle contributorHandle)
contributorHandle
- a handle to the contributor to be removed from
the process areavoid removeAllMembers()
ITeamData getTeamData()
IProjectAreaHandle getProjectArea()
null
. In case this process area is a project area the
returned handle is a handle to the project area itself.
In order for this item to be saved to the repository this field must have
a non-null value, so it is safe to assume that this method will not
return null if it is an immutable copy fetched from the repository. It is
possible for an incomplete/invalid working copy, however, to return
null
.
null
IContributorHandle[] getAdministrators()
boolean hasAdministrator(IContributorHandle contributorHandle)
true
if the contributor represented by the given
handle is an administrator of this team, false
otherwise.contributorHandle
- a handle to the contributor for which to check
administrator membershiptrue
if the contributor is an administrator,
false
otherwisevoid addAdministrator(IContributorHandle contributorHandle)
contributorHandle
- a handle to the contributor to be added as
an administrator of the process areavoid removeAdministrator(IContributorHandle contributorHandle)
contributorHandle
- a handle to the contributor to be removed as
an administrator of the process areavoid setAdministrators(IContributorHandle[] administrators)
administrators
- the administratorsjava.lang.String getProcessName()
null
if
no name has been set.null
void setProcessName(java.lang.String name)
name
- the name or null
java.lang.String getProcessSummary()
null
if no summary has been set.null
void setProcessSummary(java.lang.String summary)
summary
- the description or null
java.lang.String getProcessContentPath()
null
if none has been set.null
void setProcessContentPath(java.lang.String contentPath)
contentPath
- the path within the archive or null
java.lang.String[] getRoleAssignmentIds(IContributorHandle contributor)
Note that this method only returns the roles that are directly assigned in this area. Callers interested in finding the effective set of roles that a user has for a process area (including inheritance) should instead call: com.ibm.team.process.service.IServerProcess#getContributorRoles(IContributorHandle, IProcessArea) or com.ibm.team.process.client.IClientProcess#getContributorRoles(IContributorHandle, IProcessArea, IProgressMonitor)
contributor
- IRole[] getRoleAssignments(IContributorHandle contributor, IRole[] availableRoles)
Callers of this method should compute the set of available roles for this process area by calling either: com.ibm.team.process.service.IServerProcess#getRoles(IProcessArea) or com.ibm.team.process.client.IClientProcess#getRoles(IProcessArea, IProgressMonitor)
Callers interested in retrieving the raw set of role ids assigned to the given contributor in this process area should get getRoleAssignmentIds(...) instead.
contributor
- the contributor whose role assignments to returnavailableRoles
- the set of available roles to considervoid setRoleAssignments(IContributorHandle contributor, IRole[] roles)
Roles passed into this method should be a subset of available roles for this process area retrieved by calling either: com.ibm.team.process.service.IServerProcess#getRoles(IProcessArea) or com.ibm.team.process.client.IClientProcess#getRoles(IProcessArea, IProgressMonitor)
contributor
- the contributor whose roles to assignroles
- the roles to assignvoid addRoleAssignments(IContributorHandle contributor, IRole[] roles)
If any of the given roles are already assigned to the given contributor, those roles will be ignored. Callers wishing to reorder role assignments should call setRoleAssignments(...) instead.
Roles passed into this method should be a subset of available roles for this process area retrieved by calling either: com.ibm.team.process.service.IServerProcess#getRoles(IProcessArea) or com.ibm.team.process.client.IClientProcess#getRoles(IProcessArea, IProgressMonitor)
contributor
- the contributor whose roles to assignroles
- the roles to appendvoid removeRoleAssignments(IContributorHandle contributor, IRole[] rolesToRemove)
If any of the given roles are not assigned to the given contributor, those roles will be ignored.
Roles passed into this method should be a subset of available roles for this process area retrieved by calling either: com.ibm.team.process.service.IServerProcess#getRoles(IProcessArea) or com.ibm.team.process.client.IClientProcess#getRoles(IProcessArea, IProgressMonitor)
contributor
- the contributor whose roles to removeroles
- the roles to removeUUID getContextId(IAccessGroup.ReadAccessContextType contextType)
contextType
- the read access context of interestnull
if it hasn't been set