com.ibm.rpm.scorecard.containers
AssignedScorecardCategory

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.scorecard.containers.AbstractScorecardEntity
   extended bycom.ibm.rpm.scorecard.containers.AbstractScorecardElement
    extended bycom.ibm.rpm.scorecard.containers.AbstractScorecardCategory
     extended bycom.ibm.rpm.scorecard.containers.AssignedScorecardCategory

AssignedScorecardCategory
Extends: com.ibm.rpm.scorecard.containers.AbstractScorecardCategory
Child objects: None

Related scope: com.ibm.rpm.scorecard.scope.ScorecardCategoryScope

Scorecards are used in order to evaluate objects. Their questions and responses are set by a user. The responses are weighted on an averaged which is based on the weights in scorecard definition.

Parent is mandatory, allowed parent type is AssignedScorecard.

This object should never be created directly, in order to create AssignedScorecardCategory, the assignScorecard operation in the Application interface must be used. Refer to the RPM Web Services API Interfaces section on Application Interface Operations.

While using the assignScorecard operation it is possible to get back the AssignedScorecard object, this is done by adding the ScorecardScope to the assignedObjectScope and selecting the correct ReloadType, for details refer to the assignScorecard operation documentation. In addition, after executing the assignScorecard operation, the AssignedScorecard can be loaded using Xpath, therefore, allowing the user to change properties in those objects and save them again.

AssignedScorecard can be unassigned setting its delete property to true and saving its parent (Asset, GenericProject, AbstractScope), which subsequently deletes all the relevant AssignedScorecard, AssignedScorecardCategory, AssignedScorecardQuestion, and AssignedScorecardResponse.

AssignedScorecardCategory cannot be deleted without unassigning a Scorecard from an RPMObject.

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

ID

Field Summary
AssignedScorecardQuestion[] assignedScorecardQuestions
    List of questions contained in this assigned scorecard category.
xsd:int score
   The score of the assignedScorecard. This field is read-only.

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 description
   Description of the 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 element. This field is mandatory.
RPMObject parent
   The parent of the RPMObject.
ProbabilityType probabilityType
   The type of the weighted average.
xsd:int weight
   The weight of the element.

Field Detail

assignedScorecardQuestions


AssignedScorecardQuestion[] assignedScorecardQuestions
List of questions contained in this assigned scorecard category.

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

score


xsd:int  score
The score of the assignedScorecard. This field is read-only.

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


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.


description


xsd:string  description
Description of the element.

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

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


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 element. This field is mandatory.

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

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

Null value: This field may never be null.

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


parent


RPMObject parent
The parent of the RPMObject.

Null value: This field may never be null.

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

Scoping during creation: This field is always in scope at creation time.

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.scorecard.containers.AssignedScorecard

probabilityType


ProbabilityType probabilityType
The type of the weighted average.

Null value: This field may never be null during updates.

Relationship: This field is a reference relationship.

Default value: This default value is None.


weight


xsd:int  weight
The weight of the element.

Minimum: The minimum value for this field is 1.

Maximum: The maximum value for this field is 9999.

Null value: This field may never be null during updates.

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

Default value: This default value is 1.