com.ibm.rpm.scorecard.containers
ScorecardCategory

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

ScorecardCategory
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 average which is based on weights in the scorecard definition.

Parent is mandatory. Allowed parent type is Scorecard.

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
ScorecardQuestion[] scorecardQuestions
   An array of questions.

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

scorecardQuestions


ScorecardQuestion[] scorecardQuestions
An array of questions.

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

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.


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.


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

probabilityType


ProbabilityType probabilityType
The type of the weighted average.

Null value: This field may never be null.

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.

Default value: This default value is 1.