com.ibm.rpm.scopemanagement.containers
abstract AbstractScopeTask

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.scopemanagement.containers.ScopeElement
   extended bycom.ibm.rpm.scopemanagement.containers.AbstractScopeTask

AbstractScopeTask
Extends: com.ibm.rpm.scopemanagement.containers.ScopeElement
Child objects:
   com.ibm.rpm.scopemanagement.containers.ScopeMilestone
   com.ibm.rpm.scopemanagement.containers.ScopeTask

Related scope: com.ibm.rpm.scopemanagement.scope.ScopeElementScope

AbstractRequest is an abstract base class for ScopeTask and ScopeMilestone

Supported API Calls:

Field Summary
AttributeAssignment[] attributeAssignments
   Each instance of AttributeAssignment keeps a pointer to an assigned Attribute.
xsd:dateTime closedByDate
   The date on which the scope element was closed.
xsd:string closedByName
   The full name of the Resource that closed the scope element.
xsd:boolean mandatory
   If this field's value is true, the task is considered to be mandatory. Only the Resources with appropriate security rights will be able to delete the scope element.
xsd:int priority
   The priority of the scope element.
xsd:dateTime proposedByDate
   The date a scope element was proposed
xsd:string proposedByName
   The full name of the Resource that proposed the scope.
xsd:string referenceNumber
   The reference number of the scope element.

This field is read-only.

RtfAssignment[] rtfAssignments
   Each instance of RtfAssignment keeps a pointer to an assigned DatafieldRTF
xsd:boolean transferedUnderWbsRoot
   If this field's value is true, then the scope element has been transferred under the WBS root.

This field is read-only.

WbsFinancial[] wbsFinancials
   This array is used to track WBS financials from the project tasks or activities as team members enter time in the timesheets and expenses in the Project Expenses module.

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.
CustomFieldAssignment[] customFieldAssignments
   The custom fields assigned to the scope element.
xsd:boolean deleted
   If the value of this field is set to true, then the RPMObject will be deleted when performing a save.
ScopeElementSecurityType elementSecurityType
   Indicates the type of security applied to this element.
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.
xsd:string name
   The name of the scope element.
RPMObject parent
   The parent of the RPMObject.
xsd:string parentSortingRank
   The rank of this item's parent, currently used for sorting.
GenericProject project
   The related project from the WBS section.
ResourceTaskAssignment[] resourceTaskAssignments
   Used to identify and assign resources to the scope element.
xsd:string templateSortingRank
   The rank of the associated template.
WorkElement wbsParent
   A reference to the WBS element which owns this scopeElement. The wbsParent needs to be saved first, in order to make sure that both ScopeElement and WorkElement are to be stored in the same project.
xsd:string wbsSortingRank
   The rank of this scope item.
WorkElement workElement
   The corresponding work element from the WBS section. A scope element has a corresponding work element if it has been transferred under WBS root, or if it is a ScopeFolder that was created automatically upon the creation of a WorkElement.

Field Detail

attributeAssignments


AttributeAssignment[] attributeAssignments
Each instance of AttributeAssignment keeps a pointer to an assigned Attribute.

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

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


closedByDate


xsd:dateTime  closedByDate
The date on which the scope element was closed.

Validation: The year, month and day values will be used by this field.


closedByName


xsd:string  closedByName
The full name of the Resource that closed the scope element.

mandatory


xsd:boolean  mandatory
If this field's value is true, the task is considered to be mandatory. Only the Resources with appropriate security rights will be able to delete the scope element.

priority


xsd:int  priority
The priority of the scope element.

Minimum: The minimum value for this field is 0.

Maximum: The maximum value for this field is 10000.


proposedByDate


xsd:dateTime  proposedByDate
The date a scope element was proposed

Validation: The year, month and day values will be used by this field.


proposedByName


xsd:string  proposedByName
The full name of the Resource that proposed the scope.

referenceNumber


xsd:string  referenceNumber
The reference number of the scope element.

This field is read-only.


rtfAssignments


RtfAssignment[] rtfAssignments
Each instance of RtfAssignment keeps a pointer to an assigned DatafieldRTF

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

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


transferedUnderWbsRoot


xsd:boolean  transferedUnderWbsRoot
If this field's value is true, then the scope element has been transferred under the WBS root.

This field is read-only.


wbsFinancials


WbsFinancial[] wbsFinancials
This array is used to track WBS financials from the project tasks or activities as team members enter time in the timesheets and expenses in the Project Expenses module.

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

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


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.


customFieldAssignments


CustomFieldAssignment[] customFieldAssignments
The custom fields assigned to the scope element.

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

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


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.


elementSecurityType


ScopeElementSecurityType elementSecurityType
Indicates the type of security applied to this element.

Relationship: This field is a reference relationship.


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.


name


xsd:string  name
The name of the scope element.

Maximum: The maximum length for this field is 255 characters.


parent


RPMObject parent
The parent of the RPMObject.

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.scopemanagement.containers.Requirement
com.ibm.rpm.scopemanagement.containers.Risk
com.ibm.rpm.scopemanagement.containers.ScopeSummaryTask
com.ibm.rpm.scopemanagement.containers.ServiceRequest

parentSortingRank


xsd:string  parentSortingRank
The rank of this item's parent, currently used for sorting.

project


GenericProject project
The related project from the WBS section.

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

Relationship: This field is a reference relationship.


resourceTaskAssignments


ResourceTaskAssignment[] resourceTaskAssignments
Used to identify and assign resources to the scope element.

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

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


templateSortingRank


xsd:string  templateSortingRank
The rank of the associated template.

wbsParent


WorkElement wbsParent
A reference to the WBS element which owns this scopeElement. The wbsParent needs to be saved first, in order to make sure that both ScopeElement and WorkElement are to be stored in the same project.

Scoping: This field will be used by the API if the scope field wbsParent 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.


wbsSortingRank


xsd:string  wbsSortingRank
The rank of this scope item.

workElement


WorkElement workElement
The corresponding work element from the WBS section. A scope element has a corresponding work element if it has been transferred under WBS root, or if it is a ScopeFolder that was created automatically upon the creation of a WorkElement.

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

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

Relationship: This field is a reference relationship.