com.ibm.rpm.scopemanagement.containers
ScopeWorkProduct

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.ScopeWorkProduct

ScopeWorkProduct
Extends: com.ibm.rpm.scopemanagement.containers.AbstractAggregateScope
Child objects: None

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

This object represents a WorkProduct that was linked to a scope element.

The checkout mode type is: Self

Creation restrictions: This object may not be created. The database contains a fixed number of those objects that may be updated.

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

ID

Creation restrictions: This object can only be created by transferring a WBS WorkProduct element under a Scope Element.

Inherited Field Summary
AttributeAssignment[] attributeAssignments
    Each instance of AttributeAssignment keeps a pointer to an assigned Attribute.
ScopeElement[] children
   The children of the scope element.
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 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: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 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.
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.

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.
StatusUpdate[] statusUpdates
    The list of status updates for this scope element.
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.
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.

Inherited 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.


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.


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.


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.


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.


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.


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.


referenceNumber


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

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.


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.


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.


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.