com.ibm.rpm.scopemanagement.containers
ScopeElement

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

ScopeElement
Extends: com.ibm.rpm.framework.RPMObject
Child objects:
   com.ibm.rpm.scopemanagement.containers.AbstractAggregateScope
   com.ibm.rpm.scopemanagement.containers.AbstractRequest
   com.ibm.rpm.scopemanagement.containers.AbstractScope
   com.ibm.rpm.scopemanagement.containers.AbstractScopeTask
   com.ibm.rpm.scopemanagement.containers.Action
   com.ibm.rpm.scopemanagement.containers.AggregateScope
   com.ibm.rpm.scopemanagement.containers.ChangeRequest
   com.ibm.rpm.scopemanagement.containers.Defect
   com.ibm.rpm.scopemanagement.containers.Issue
   com.ibm.rpm.scopemanagement.containers.ReqProIntegrationFolder
   com.ibm.rpm.scopemanagement.containers.ReqProRequirement
   com.ibm.rpm.scopemanagement.containers.ReqProScopeFolder
   com.ibm.rpm.scopemanagement.containers.Requirement
   com.ibm.rpm.scopemanagement.containers.Risk
   com.ibm.rpm.scopemanagement.containers.ScopeDeliverable
   com.ibm.rpm.scopemanagement.containers.ScopeFolder
   com.ibm.rpm.scopemanagement.containers.ScopeMilestone
   com.ibm.rpm.scopemanagement.containers.ScopeSummaryTask
   com.ibm.rpm.scopemanagement.containers.ScopeTask
   com.ibm.rpm.scopemanagement.containers.ScopeWorkProduct
   com.ibm.rpm.scopemanagement.containers.ServiceRequest

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

ScopeElement is the base class for all scope element containers in the Scope Management section.

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
CustomFieldAssignment[] customFieldAssignments
   The custom fields assigned to the scope element.
ScopeElementSecurityType elementSecurityType
   Indicates the type of security applied to this element.
xsd:string name
   The name of the scope element.
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.

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

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.


elementSecurityType


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

Relationship: This field is a reference relationship.


name


xsd:string  name
The name of the scope element.

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


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.


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.