com.ibm.rpm.wbs.containers
Portfolio

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.wbs.containers.Portfolio

Portfolio
Extends: com.ibm.rpm.framework.RPMObject
Child objects: None

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

Portfolios are created by one user and are not available to other users.

Parent is not mandatory.

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
xsd:string name
   The portfolio name.
Portfolio[] portfolios
   
GenericProject[] projects
   List of projects, proposals, and work organizations. When the Portfolio is deleted, the projects are moved to the parent of the current Portfolio.

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

name


xsd:string  name
The portfolio name.

Minimum: The minimum length for this field is 1 characters.

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

Null value: This field may never be null.


portfolios


Portfolio[] portfolios

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.


projects


GenericProject[] projects
List of projects, proposals, and work organizations. When the Portfolio is deleted, the projects are moved to the parent of the current Portfolio.

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

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

Valid types:
com.ibm.rpm.wbs.containers.Project
com.ibm.rpm.wbs.containers.Proposal
com.ibm.rpm.wbs.containers.WorkOrganization

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.

Valid types:
com.ibm.rpm.wbs.containers.Portfolio
com.ibm.rpm.wbs.containers.WbsModule