com.ibm.rpm.scopemanagement.containers
Requirement

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.scopemanagement.containers.ScopeElement
   extended bycom.ibm.rpm.scopemanagement.containers.AggregateScope
    extended bycom.ibm.rpm.scopemanagement.containers.AbstractAggregateScope
     extended bycom.ibm.rpm.scopemanagement.containers.AbstractScope
      extended bycom.ibm.rpm.scopemanagement.containers.Requirement

Requirement
Extends: com.ibm.rpm.scopemanagement.containers.AbstractScope
Child objects:
   com.ibm.rpm.scopemanagement.containers.ReqProRequirement

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

Requirements allow managers to break the project scope into manageable and trackable elements.

In their simplest form requirements can be defined as project scope elements and deliverables. When these requirements are contained in other point solutions or applications, the tracking of project delivery is usually a manual process. Managers are forced to report project performance in different ways because project work breakdown structures do not necessarily map directly to project or business requirements.

IBM Rational Portfolio Manager offers the unique ability to create project requirements and to map the project work breakdown structure to these requirements. Furthermore, as IBM Rational Portfolio Manager project artifacts; requirements can be subjected to the same rigorous processes used to manage such elements as project documents.

A requirement cannot exist unless a folder exists.

Parent is mandatory, allowed parent types are ScopeFolder, Action, Issue, ChangeRequest, Defect, Requirement, Risk and ServiceRequest.

The checkout mode type is: Self

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
ApprovedCostBenefits approvedCostBenefits
   The approved costs and benefits of the requirement, which are used to identify the approved schedule impact, effort required as well as the costs and benefits..

Inherited Field Summary
xsd:dateTime approvedByDate
   The date a scope element was approved
xsd:string approvedByName
   FullName of the Resource that approved this scope element.
ScopeScheduleDate approvedDate
   The scheduled dates that have been approved for the scope element.

This field is read-only.

Asset asset
   The asset to which the scope element is attributed.
AssetFinancialCategory assetCode
   The asset's financial category.
AssignedScorecard assignedScorecard
   The scorecards that have been assigned to this scope element.
AttributeAssignment[] attributeAssignments
    Each instance of AttributeAssignment keeps a pointer to an assigned Attribute.
ScopeElement[] children
   The children of the scope element.
ClientCostCenter clientCostCenter
   The scope element's client / cost center
xsd:dateTime closedByDate
    The date on which the scope element was closed.
xsd:string closedByName
    FullName of the Resource that closed the scope element
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 defaultScope
   Indicates whether or not the current scope element is the default
xsd:boolean deleted
   If the value of this field is set to true, then the RPMObject will be deleted when performing a save.
DocumentFolder documentFolder
   This folder contains the documents associated to the scope element. It is created automatically when the scope element is created.
xsd:string duplicateNumber
   The unique duplicate key for the group of scope elements that are duplicates of each other. If two scope elements have the same value of duplicateNumber, then they are duplicates of each other.

This field is read-only.

Duplicate[] duplicates
   The duplicate scope elements. Each instance of Duplicate keeps a pointer to a ScopeElement .
ScopeElementSecurityType elementSecurityType
   Indicates the type of security applied to this element.
xsd:int estimatedDurationInMinutes
    The estimated duration in minutes when the scope element should be completed.
xsd:dateTime estimatedFinishDate
    The estimated date when the scope element should be completed. When the field is set to null, it is calculated from the estimatedStartDate and the estimatedDurationInMinutes.
xsd:dateTime estimatedStartDate
    The estimated start date for the scope element.
xsd:string externalReferenceNumber
   The external reference number of the scope 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.
Impact impact
   The Quantification / Impact of the scope element.
xsd:string name
   The name of the scope element.
OrderOfMagnitudeCostBenefits orderOfMagnitudeCostBenefits
   The order of magnitude of the scope element's preliminary costs and benefits.
RPMObject parent
   The parent of the RPMObject.
xsd:string parentSortingRank
   The rank of this item's parent, currently used for sorting.
xsd:int priority
    The priority of the scope element.
GenericProject project
   The related project from the WBS section.
xsd:dateTime proposedByDate
    The date a scope element was proposed.
xsd:string proposedByName
    FullName of the Resource that proposed this scope element.
ScopeScheduleDate proposedDate
    The scheduled dates that have been proposed for the scope element.

This field is read-only.

PublishedType published
   : The type of publishing of the scope element.
xsd:int rank
    Rank of the scope element.
xsd:string referenceNumber
    The reference number of the scope element.

This field is read-only.

ResourceTaskAssignment[] resourceTaskAssignments
   Used to identify and assign resources to the scope element.
RtfAssignment[] rtfAssignments
    Each instance of RtfAssignment keeps a reference to an assigned DatafieldRTF.
DatafieldState state
   The current state of the scope element.
StatusUpdate[] statusUpdates
    The list of status updates for this scope element.
xsd:dateTime targetDate
   The target date of the scope element.
xsd:boolean task
    This flag indicates if the scope element is a task or not. If a scope element has child elements either in Scope or WBS, then the task flag is false and may not be changed. If this flag is set to true, then no children may be added under this scope element in both WBS and Scope Management.
xsd:string templateSortingRank
   The rank of the associated template.
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.
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.
AvailableWorkflowProcess[] workflowProcessesAvailable
   List of available WorkflowProcesses for this AbstractScope.
RunningWorkflowProcess[] workflowProcessesRunning
   List of running WorkflowProcesses for this AbstractScope.
WorksheetFinancial[] worksheetFinancials
    This array is used to estimate labor and non-labor budgets, as well as to manually enter track labor and non-labor actuals. Project Managers can use worksheet financials to estimate project budgets. This allows them to understand project budget requirements and can also be used as information to justify or disqualify a proposal during the Portfolio Management decision-making process. It can also be used to provide a top-down budgeting mechanism that can be used to distribute high-level estimates over a basic or complex project plan and to compare the resultant aggregate with the higher level estimates to insure that budgets align. Actuals can also be entered manually to track a project without the necessity of a project plan.

Field Detail

approvedCostBenefits


ApprovedCostBenefits approvedCostBenefits
The approved costs and benefits of the requirement, which are used to identify the approved schedule impact, effort required as well as the costs and benefits..

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

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


Inherited Field Detail

approvedByDate


xsd:dateTime  approvedByDate
The date a scope element was approved

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


approvedByName


xsd:string  approvedByName
FullName of the Resource that approved this scope element.

approvedDate


ScopeScheduleDate approvedDate
The scheduled dates that have been approved for the scope element.

This field is read-only.

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

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


asset


Asset asset
The asset to which the scope element is attributed.

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

Relationship: This field is a reference relationship.


assetCode


AssetFinancialCategory assetCode
The asset's financial category.

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

Relationship: This field is a reference relationship.


assignedScorecard


AssignedScorecard assignedScorecard
The scorecards that have been assigned to this scope element.

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

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


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.


children


ScopeElement[] children
The children of the scope element.

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

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


clientCostCenter


ClientCostCenter clientCostCenter
The scope element's client / cost center

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

Relationship: This field is a reference relationship.


closedByDate


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

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

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


closedByName


xsd:string  closedByName
FullName of the Resource that closed the scope element

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.


defaultScope


xsd:boolean  defaultScope
Indicates whether or not the current scope element is the default

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.


documentFolder


DocumentFolder documentFolder
This folder contains the documents associated to the scope element. It is created automatically when the scope element is created.

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

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


duplicateNumber


xsd:string  duplicateNumber
The unique duplicate key for the group of scope elements that are duplicates of each other. If two scope elements have the same value of duplicateNumber, then they are duplicates of each other.

This field is read-only.

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


duplicates


Duplicate[] duplicates
The duplicate scope elements. Each instance of Duplicate keeps a pointer to a ScopeElement .

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

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


elementSecurityType


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

Relationship: This field is a reference relationship.


estimatedDurationInMinutes


xsd:int  estimatedDurationInMinutes
The estimated duration in minutes when the scope element should be completed.

estimatedFinishDate


xsd:dateTime  estimatedFinishDate
The estimated date when the scope element should be completed. When the field is set to null, it is calculated from the estimatedStartDate and the estimatedDurationInMinutes.

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


estimatedStartDate


xsd:dateTime  estimatedStartDate
The estimated start date for the scope element.

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


externalReferenceNumber


xsd:string  externalReferenceNumber
The external reference number of the scope element.

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


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.


impact


Impact impact
The Quantification / Impact of the scope element.

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

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


name


xsd:string  name
The name of the scope element.

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


orderOfMagnitudeCostBenefits


OrderOfMagnitudeCostBenefits orderOfMagnitudeCostBenefits
The order of magnitude of the scope element's preliminary costs and benefits.

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

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


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

parentSortingRank


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

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.


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.


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
FullName of the Resource that proposed this scope element.

proposedDate


ScopeScheduleDate proposedDate
The scheduled dates that have been proposed for the scope element.

This field is read-only.

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

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


published


PublishedType published
: The type of publishing of the scope element.

Relationship: This field is a reference relationship.


rank


xsd:int  rank
Rank of the scope element.

Minimum: The minimum value for this field is 0.

Maximum: The maximum value for this field is 1000.


referenceNumber


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

This field is read-only.

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


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.


rtfAssignments


RtfAssignment[] rtfAssignments
Each instance of RtfAssignment keeps a reference 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.


state


DatafieldState state
The current state of the scope element.

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

Relationship: This field is a reference relationship.

Valid types:
com.ibm.rpm.applicationadministration.containers.ServiceRequestState

statusUpdates


StatusUpdate[] statusUpdates
The list of status updates for this scope element.

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


targetDate


xsd:dateTime  targetDate
The target date of the scope element.

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


task


xsd:boolean  task
This flag indicates if the scope element is a task or not. If a scope element has child elements either in Scope or WBS, then the task flag is false and may not be changed. If this flag is set to true, then no children may be added under this scope element in both WBS and Scope Management.

templateSortingRank


xsd:string  templateSortingRank
The rank of the associated template.

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.

Read-only behavior: The value of 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.


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.


workflowProcessesAvailable


AvailableWorkflowProcess[] workflowProcessesAvailable
List of available WorkflowProcesses for this AbstractScope.

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

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

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


workflowProcessesRunning


RunningWorkflowProcess[] workflowProcessesRunning
List of running WorkflowProcesses for this AbstractScope.

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

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

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


worksheetFinancials


WorksheetFinancial[] worksheetFinancials
This array is used to estimate labor and non-labor budgets, as well as to manually enter track labor and non-labor actuals. Project Managers can use worksheet financials to estimate project budgets. This allows them to understand project budget requirements and can also be used as information to justify or disqualify a proposal during the Portfolio Management decision-making process. It can also be used to provide a top-down budgeting mechanism that can be used to distribute high-level estimates over a basic or complex project plan and to compare the resultant aggregate with the higher level estimates to insure that budgets align. Actuals can also be entered manually to track a project without the necessity of a project plan.

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

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