com.ibm.rpm.security.containers
DocumentSecurityRole

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
     extended bycom.ibm.rpm.security.containers.AbstractDocumentSecurityRole
      extended bycom.ibm.rpm.security.containers.DocumentSecurityRole

DocumentSecurityRole
Extends: com.ibm.rpm.security.containers.AbstractDocumentSecurityRole
Child objects: None

Related scope: com.ibm.rpm.security.scope.SecurityRoleScope

DocumentSecurityRole represents document security role.

Parent is mandatory, allowed parent type is SecurityGroup.

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

ID

Field Summary
xsd:boolean canCheckOutOrCheckOutTo
   Indicates that the "Check Out" and the "Check Out To" operations are available.
xsd:boolean canEditDocumentSummary
   Indicates that DocumentSummary can be edited.
xsd:boolean canEditKeywords
   Indicates that Keywords can be edited.
xsd:boolean canEditReferenceNumber
   Indicates that ReferenceNumber can be edited.
xsd:boolean canMoveAcrossProjects
   Indicates that the document can be moved across projects.
xsd:boolean canSaveAs
   Indicates that the "save as" operation is available on the document.
xsd:boolean canViewDocumentProperties
   Indicates that DocumentProperties can be viewed.
xsd:boolean canViewDocumentSummary
   Indicates that DocumentSummary can be viewed.
xsd:boolean canViewKeywords
   Indicates that Keywords can be viewed.
xsd:boolean canViewReferenceNumber
   Indicates that ReferenceNumber can be viewed.
DocumentSecurityRoleType type
   The type of security role.

Inherited Field Summary
xsd:boolean canAddRemoveAttributes
   Indicates that Attributes can be added and removed.
xsd:boolean canAssignParticipant
   Indicates that Participant can be assigned.
xsd:boolean canBreakdown
   Indicates that Breakdown is enabled
xsd:boolean canDelete
   Indicates that the notes can be deleted.
xsd:boolean canEditAttributes
   Indicates that Attributes can be edited.
ArrayOf_xsd_boolean canEditCustomFieldsGroups
   Indicates that CustomFieldsGroups can be edited.
xsd:boolean canEditElementSecurity
   Indicates that ElementSecurity can be edited.
xsd:boolean canEditSecurityLevel
   Indicates that SecurityLevel can be edited.
xsd:boolean canEditState
   Indicates that State can be edited.
xsd:boolean canEditVisibleAtParent
   Indicates that VisibleAtParent can be edited.
xsd:boolean canEditWorkflowScheduling
    Indicates that WorkflowScheduling can be edited.
xsd:boolean canLockUnlock
   Indicates that the notes minutes can be Lock or Unlock.
xsd:boolean canManageManualWorkflows
   Indicates that Workflow can be stopped.
xsd:boolean canManageScheduledWorkflows
    Indicates that the user can manage scheduled workflows.
xsd:boolean canPermanentlyDelete
   Indicates that the notes minutes can be permanently deleted.
xsd:boolean canRemoveParticipant
   Indicates that Participant can be removed.
xsd:boolean canRename
   Indicates that the notes minutes can be renamed.
xsd:boolean canStartManualWorkflow
   Indicates that Workflow can be started.
xsd:boolean canUnlockAny
   Indicates that Any can be unlocked.
xsd:boolean canViewAssignments
   Indicates that Assignments can be viewed.
xsd:boolean canViewAttributes
   Indicates that Attributes can be viewed.
ArrayOf_xsd_boolean canViewCustomFieldsGroups
   Indicates that CustomFieldsGroups can be viewed.
xsd:boolean canViewElementSecurity
   Indicates you that ElementSecurity can be viewed.
xsd:boolean canViewHistory
   Indicates that History can be viewed.
xsd:boolean canViewVisibleAtParent
   Indicates that VisibleAtParent can be viewed.
xsd:boolean canViewWorkflowScheduling
    Indicates that WorkflowScheduling can be viewed.
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

canCheckOutOrCheckOutTo


xsd:boolean  canCheckOutOrCheckOutTo
Indicates that the "Check Out" and the "Check Out To" operations are available.

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.


canEditDocumentSummary


xsd:boolean  canEditDocumentSummary
Indicates that DocumentSummary 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.


canEditKeywords


xsd:boolean  canEditKeywords
Indicates that Keywords 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.


canEditReferenceNumber


xsd:boolean  canEditReferenceNumber
Indicates that ReferenceNumber 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.


canMoveAcrossProjects


xsd:boolean  canMoveAcrossProjects
Indicates that the document can be moved across projects.

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.


canSaveAs


xsd:boolean  canSaveAs
Indicates that the "save as" operation is available on the document.

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.


canViewDocumentProperties


xsd:boolean  canViewDocumentProperties
Indicates that DocumentProperties 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.


canViewDocumentSummary


xsd:boolean  canViewDocumentSummary
Indicates that DocumentSummary 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.


canViewKeywords


xsd:boolean  canViewKeywords
Indicates that Keywords 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.


canViewReferenceNumber


xsd:boolean  canViewReferenceNumber
Indicates that ReferenceNumber 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.


type


DocumentSecurityRoleType type
The type of security role.

Relationship: This field is a reference relationship.


Inherited Field Detail

canAddRemoveAttributes


xsd:boolean  canAddRemoveAttributes
Indicates that Attributes can be added and removed.

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.


canAssignParticipant


xsd:boolean  canAssignParticipant
Indicates that Participant can be assigned.

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.


canBreakdown


xsd:boolean  canBreakdown
Indicates that Breakdown is enabled

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.


canDelete


xsd:boolean  canDelete
Indicates that the notes can be deleted.

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.


canEditAttributes


xsd:boolean  canEditAttributes
Indicates that Attributes 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.


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.


canEditElementSecurity


xsd:boolean  canEditElementSecurity
Indicates that ElementSecurity 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.


canEditSecurityLevel


xsd:boolean  canEditSecurityLevel
Indicates that SecurityLevel 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.


canEditState


xsd:boolean  canEditState
Indicates that State 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.


canEditVisibleAtParent


xsd:boolean  canEditVisibleAtParent
Indicates that VisibleAtParent 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.


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.


canLockUnlock


xsd:boolean  canLockUnlock
Indicates that the notes minutes can be Lock or Unlock.

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.


canPermanentlyDelete


xsd:boolean  canPermanentlyDelete
Indicates that the notes minutes can be permanently deleted.

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.


canRemoveParticipant


xsd:boolean  canRemoveParticipant
Indicates that Participant can be removed.

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.


canRename


xsd:boolean  canRename
Indicates that the notes minutes can be renamed.

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.


canUnlockAny


xsd:boolean  canUnlockAny
Indicates that Any can be unlocked.

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.


canViewAssignments


xsd:boolean  canViewAssignments
Indicates that Assignments 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.


canViewAttributes


xsd:boolean  canViewAttributes
Indicates that Attributes 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.


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.


canViewElementSecurity


xsd:boolean  canViewElementSecurity
Indicates you that ElementSecurity 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.


canViewHistory


xsd:boolean  canViewHistory
Indicates that History 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.


canViewVisibleAtParent


xsd:boolean  canViewVisibleAtParent
Indicates that VisibleAtParent 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.


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.


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.