com.ibm.rpm.security.containers
abstract AbstractSecurityRole

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.security.containers.GenericSecurityRole
   extended bycom.ibm.rpm.security.containers.SecurityRole
    extended bycom.ibm.rpm.security.containers.AbstractSecurityRole

AbstractSecurityRole
Extends: com.ibm.rpm.security.containers.SecurityRole
Child objects:
   com.ibm.rpm.security.containers.AbstractDeliverableSecurityRole
   com.ibm.rpm.security.containers.AbstractDocumentSecurityRole
   com.ibm.rpm.security.containers.AbstractScopeSecurityRole
   com.ibm.rpm.security.containers.AbstractWbsSecurityRole
   com.ibm.rpm.security.containers.ActionItemSecurityRole
   com.ibm.rpm.security.containers.ChangeRequestSecurityRole
   com.ibm.rpm.security.containers.DefectSecurityRole
   com.ibm.rpm.security.containers.DeliverableSecurityRole
   com.ibm.rpm.security.containers.DocumentSecurityRole
   com.ibm.rpm.security.containers.IssueSecurityRole
   com.ibm.rpm.security.containers.NotesMinutesSecurityRole
   com.ibm.rpm.security.containers.ProjectSecurityRole
   com.ibm.rpm.security.containers.RequirementSecurityRole
   com.ibm.rpm.security.containers.RiskSecurityRole
   com.ibm.rpm.security.containers.ServiceRequestSecurityRole
   com.ibm.rpm.security.containers.TaskSecurityRole

Related scope: com.ibm.rpm.framework.RPMObjectScope

This class is used to regroup common security role flags. When the canEditCustomFieldsGroups flags is set to true, the corresponding canViewCustomFieldsGroups flags must be set to true. Otherwise, the new canEditCustomFieldsGroups flags value will not be saved in the database. For example, getCanEditCustomFieldsGroups()[0] = true; getCanViewCustomFieldsGroups()[0] = true;

Supported API Calls:

Field Summary
ArrayOf_xsd_boolean canEditCustomFieldsGroups
   Indicates that CustomFieldsGroups can be edited.
xsd:boolean canEditWorkflowScheduling
    Indicates that WorkflowScheduling can be edited.
xsd:boolean canManageManualWorkflows
   Indicates that Workflow can be stopped.
xsd:boolean canManageScheduledWorkflows
    Indicates that the user can manage scheduled workflows.
xsd:boolean canStartManualWorkflow
   Indicates that Workflow can be started.
ArrayOf_xsd_boolean canViewCustomFieldsGroups
   Indicates that CustomFieldsGroups can be viewed.
xsd:boolean canViewWorkflowScheduling
    Indicates that WorkflowScheduling can be viewed.

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.
xsd:string name
   Name of the security role
RPMObject parent
   The parent of the RPMObject.
SecurityRole[] securityRoles
   Child Security role array.

Field Detail

canEditCustomFieldsGroups


ArrayOf_xsd_boolean  canEditCustomFieldsGroups
Indicates that CustomFieldsGroups can be edited.

The value of this field has a fixed length of 10.

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

X-Path availability: This field doesn't support X-Path queries.

Default value: This default value is false.


canEditWorkflowScheduling


xsd:boolean  canEditWorkflowScheduling
Indicates that WorkflowScheduling can be edited.

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

X-Path availability: This field doesn't support X-Path queries.

Default value: This default value is false.


canManageManualWorkflows


xsd:boolean  canManageManualWorkflows
Indicates that Workflow can be stopped.

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

X-Path availability: This field doesn't support X-Path queries.

Default value: This default value is false.


canManageScheduledWorkflows


xsd:boolean  canManageScheduledWorkflows
Indicates that the user can manage scheduled workflows.

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

X-Path availability: This field doesn't support X-Path queries.

Default value: This default value is false.


canStartManualWorkflow


xsd:boolean  canStartManualWorkflow
Indicates that Workflow can be started.

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

X-Path availability: This field doesn't support X-Path queries.

Default value: This default value is false.


canViewCustomFieldsGroups


ArrayOf_xsd_boolean  canViewCustomFieldsGroups
Indicates that CustomFieldsGroups can be viewed.

The value of this field has a fixed length of 10.

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

X-Path availability: This field doesn't support X-Path queries.

Default value: This default value is false.


canViewWorkflowScheduling


xsd:boolean  canViewWorkflowScheduling
Indicates that WorkflowScheduling can be viewed.

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

X-Path availability: This field doesn't support X-Path queries.

Default value: This default value is false.


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.


name


xsd:string  name
Name of the security role

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.

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.security.containers.ActionItemSecurityRole
com.ibm.rpm.security.containers.ChangeRequestSecurityRole
com.ibm.rpm.security.containers.DefectSecurityRole
com.ibm.rpm.security.containers.DeliverableSecurityRole
com.ibm.rpm.security.containers.DocumentSecurityRole
com.ibm.rpm.security.containers.FolderSecurityRole
com.ibm.rpm.security.containers.IssueSecurityRole
com.ibm.rpm.security.containers.NotesMinutesSecurityRole
com.ibm.rpm.security.containers.PoolSecurityRole
com.ibm.rpm.security.containers.ProjectSecurityRole
com.ibm.rpm.security.containers.RequirementSecurityRole
com.ibm.rpm.security.containers.RiskSecurityRole
com.ibm.rpm.security.containers.SecurityRoleCategory
com.ibm.rpm.security.containers.ServiceRequestSecurityRole
com.ibm.rpm.security.containers.TaskSecurityRole
com.ibm.rpm.security.containers.TemplateFolderSecurityRole

securityRoles


SecurityRole[] securityRoles
Child Security role array.

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

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

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

X-Path availability: This field doesn't support X-Path queries.