com.ibm.rpm.wbs.containers
WbsModule

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.framework.containers.AbstractModule
   extended bycom.ibm.rpm.wbs.containers.WbsModule

WbsModule
Extends: com.ibm.rpm.framework.containers.AbstractModule
Child objects: None

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

This module class is used to load all relevant containers related to Work Element.

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
AssetFinancialCategory[] assetFinancialCategories
   The list of AssetFinancialCategory containers associated with the module.
AssignmentStatus[] assignmentStatus
   The list of AssignmentStatus containers associated with the module.
AttributeCategory[] attributeCategories
   The list of AttributeCategory containers associated with the module.
CustomFieldCategory[] customFieldCategories
   The list of CustomFieldCategory containers associated with the module.
DeliverableRTF[] deliverableRtfs
   The list of DeliverableRTF containers associated with the module.
DeliverableState[] deliverableStates
   The list of DeliverableState containers associated with the module.
GenericProject[] genericProjects
   The list of GenericProject containers associated with the module.
MilestoneRTF[] milestoneRtfs
   The list of MilestoneRTF containers associated with the module.
Portfolio[] portfolios
   The list of Portfolio containers associated with the module.
ProjectRTF[] projectRtfs
   The list of ProjectRTF containers associated with the module.
ScorecardFolder[] scorecardFolders
   The list of ScorecardFolder containers associated with the module.
State[] states
   The list of State containers associated with the module.
SummaryTaskRTF[] summaryTaskRtfs
   The list of SummaryTaskRTF containers associated with the module.
TaskRTF[] taskRtfs
   The list of TaskRTF containers associated with the module.
TaskState[] taskStates
   The list of TaskState containers associated with the module.
WorkLocation[] workLocations
   The list of WorkLocation containers associated with the module.
WorkProductRTF[] workProductRtfs
   The list of WorkProductRTF containers associated with the 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.
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.

Field Detail

assetFinancialCategories


AssetFinancialCategory[] assetFinancialCategories
The list of AssetFinancialCategory containers associated with the module.

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

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


assignmentStatus


AssignmentStatus[] assignmentStatus
The list of AssignmentStatus containers associated with the module.

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

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


attributeCategories


AttributeCategory[] attributeCategories
The list of AttributeCategory containers associated with the module.

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

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


customFieldCategories


CustomFieldCategory[] customFieldCategories
The list of CustomFieldCategory containers associated with the module.

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

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


deliverableRtfs


DeliverableRTF[] deliverableRtfs
The list of DeliverableRTF containers associated with the module.

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

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


deliverableStates


DeliverableState[] deliverableStates
The list of DeliverableState containers associated with the module.

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

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


genericProjects


GenericProject[] genericProjects
The list of GenericProject containers associated with the module.

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

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


milestoneRtfs


MilestoneRTF[] milestoneRtfs
The list of MilestoneRTF containers associated with the module.

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

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


portfolios


Portfolio[] portfolios
The list of Portfolio containers associated with the module.

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

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


projectRtfs


ProjectRTF[] projectRtfs
The list of ProjectRTF containers associated with the module.

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

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


scorecardFolders


ScorecardFolder[] scorecardFolders
The list of ScorecardFolder containers associated with the module.

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

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


states


State[] states
The list of State containers associated with the module.

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

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


summaryTaskRtfs


SummaryTaskRTF[] summaryTaskRtfs
The list of SummaryTaskRTF containers associated with the module.

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

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


taskRtfs


TaskRTF[] taskRtfs
The list of TaskRTF containers associated with the module.

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

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


taskStates


TaskState[] taskStates
The list of TaskState containers associated with the module.

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

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


workLocations


WorkLocation[] workLocations
The list of WorkLocation containers associated with the module.

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

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


workProductRtfs


WorkProductRTF[] workProductRtfs
The list of WorkProductRTF containers associated with the module.

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


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.

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.