com.ibm.rpm.wbs.containers
ResourceTaskAssignment

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.security.containers.SecurityRoleAssignment
   extended bycom.ibm.rpm.resource.containers.ResourceRoleAssignment
    extended bycom.ibm.rpm.wbs.containers.ResourceTaskAssignment

ResourceTaskAssignment
Extends: com.ibm.rpm.resource.containers.ResourceRoleAssignment
Child objects: None

Related scope: com.ibm.rpm.wbs.scope.ResourceTaskAssignmentScope

ResourceTaskAssignment is used to assign work to a Resource, by assigning a Resource as a participant, or assigning work to a Profile.

To assign a Resource as a participant, you must create a ResourceTaskAssignment object specifying an existing parent and an existing Resource in the corresponding fields. The profile and taskAssignment fields should remain null.

To assign work to a Resource, you must create a ResourceTaskAssignment object with an existing parent, an existing Resource, and a new TaskAssignment object in the corresponding fields. The profile field should remain null. To create a ResourceTaskAssignment object with a Resource, the Resource must be active and previously saved.

To assign work to a Profile, you must create a ResourceTaskAssignment object with an existing parent and a new Profile object as well as a new TaskAssignment object in the corresponding fields. The resource field should remain null.A TaskAssignment must be created when the parent ResourceTaskAssignment is created.

In order to delete a TaskAssignment, you must delete the parent ResourceTaskAssignment. ResourceTaskAssignments with security roles 'Project Manager' and 'Task Responsible' cannot be deleted.

Parent is mandatory and must be saved, allowed parent types are Proposal, Project, WorkOrganization, Deliverable, WorkProduct, SummaryTask, Milestone, and Task.

The field securityRole, inherited from SecurityRoleAssignment, is mandatory when creating or updating a ResourceTaskAssignment.

The checkout mode type is: Parent

Supported API Calls: Primary key: The following fields are required when using the loadFromID and loadArrayFromID methods:

ID

Related code samples :

Java

C#

Field Summary
AssignmentStatus assignmentStatus
   The status of the resource's assignment (Work or Duration).
Contour contour
   Identifies Contourbeing used to assign a resource or profile.
Profile profile
   The profile associated with a profile assignment.
ResourceType resourceType
   Identifies if a Profile or a Resource is being assigned.
TaskAssignment taskAssignment
   The task assignment data for a resource or profile assignment.

Inherited Field Summary
xsd:string contextName
   The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.
xsd:boolean deleted
   If the value of this field is set to true, then the RPMObject will be deleted when performing a save.
xsd:string ID
   The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.
RPMObject parent
   The parent of the RPMObject.
Resource resource
   The resource
SecurityRole securityRole
   The Security Role used for the assignment

Field Detail

assignmentStatus


AssignmentStatus assignmentStatus
The status of the resource's assignment (Work or Duration).

Scoping: This field will be used by the API if the scope field assignmentStatus is enabled.

Read-only behavior: The value of this field is read only.

Relationship: This field is a reference relationship.


contour


Contour contour
Identifies Contourbeing used to assign a resource or profile.

Relationship: This field is a reference relationship.


profile


Profile profile
The profile associated with a profile assignment.

Scoping: This field will be used by the API if the scope field profile is enabled.

Relationship: This field is a reference relationship.

Null value: This field is mandatory for a profile assignment.


resourceType


ResourceType resourceType
Identifies if a Profile or a Resource is being assigned.

Read-only behavior: The value of this field is read only.

Relationship: This field is a reference relationship.


taskAssignment


TaskAssignment taskAssignment
The task assignment data for a resource or profile assignment.

Scoping: This field will be used by the API if the scope field taskAssignment is enabled.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.

Null value: This field is mandatory for a profile or resource assignment.


Inherited Field Detail

contextName


xsd:string  contextName
The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


deleted


xsd:boolean  deleted
If the value of this field is set to true, then the RPMObject will be deleted when performing a save.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


ID


xsd:string  ID
The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.

Read-only behavior: The value of this field is read only.


parent


RPMObject parent
The parent of the RPMObject.

Null value: This field may never be null.

Scoping: This field will be used by the API if the scope field parent is enabled.

Read-only behavior: The value of this field is read only after the object was created.

Relationship: This field is a reference relationship.

X-Path availability: This field doesn't support X-Path queries.

Valid types:
com.ibm.rpm.scopemanagement.containers.Action
com.ibm.rpm.scopemanagement.containers.ChangeRequest
com.ibm.rpm.scopemanagement.containers.Defect
com.ibm.rpm.wbs.containers.Deliverable
com.ibm.rpm.scopemanagement.containers.Issue
com.ibm.rpm.wbs.containers.Milestone
com.ibm.rpm.wbs.containers.Project
com.ibm.rpm.wbs.containers.Proposal
com.ibm.rpm.scopemanagement.containers.Requirement
com.ibm.rpm.scopemanagement.containers.Risk
com.ibm.rpm.scopemanagement.containers.ScopeDeliverable
com.ibm.rpm.scopemanagement.containers.ScopeMilestone
com.ibm.rpm.scopemanagement.containers.ScopeSummaryTask
com.ibm.rpm.scopemanagement.containers.ScopeTask
com.ibm.rpm.scopemanagement.containers.ServiceRequest
com.ibm.rpm.wbs.containers.SummaryTask
com.ibm.rpm.wbs.containers.Task
com.ibm.rpm.wbs.containers.WorkOrganization
com.ibm.rpm.wbs.containers.WorkProduct

resource


Resource resource
The resource

Null value: This field may never be null.

Scoping: This field will be used by the API if the scope field @Default is enabled.

Relationship: This field is a reference relationship.

Null value: If this field is not null, the resource must be active and previously saved.


securityRole


SecurityRole securityRole
The Security Role used for the assignment

Null value: This field may never be null.

Relationship: This field is a reference relationship.

Valid types:
com.ibm.rpm.security.containers.TaskSecurityRole