com.ibm.rpm.security.containers
FolderSecurityRole

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

FolderSecurityRole
Extends: com.ibm.rpm.security.containers.SecurityRole
Child objects: None

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

FolderSecurityRole represents a folder 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 canAssignParticipant
   Indicates that Participant can be assigned.
xsd:boolean canBreakdownFolders
   Indicates that Folders can be broken-down.
xsd:boolean canDeleteFolders
   Indicates that Folders can be deleted.
xsd:boolean canEditReqProFolder
    Indicates that ReqProFolder can be edited.
xsd:boolean canEditSecurityLevel
   Indicates that SecurityLevel can be edited.
xsd:boolean canManageManualWorkflows
   Indicates that Workflow can be managed.
xsd:boolean canPermanentlyDeleteFolder
   Indicates that Folder can be permanently deleted.
xsd:boolean canPublishRenderPrivateFolder
   Indicates that RenderPrivateFolder can be published.
xsd:boolean canRemoveParticipant
   Indicates that Participant can be removed.
xsd:boolean canRenameFolders
   Indicates that Folders can be renamed.
xsd:boolean canStartManualWorkflow
   Indicates that Workflow can be started.
xsd:boolean canTransferOrMoveScopeElementsAcrossProjects
   Indicates that ScopeElements can be transferred or moved across projects.
xsd:boolean canTransferScopeElementsToWBSView
   Indicates that ScopeElements can be transferred to WBS view.
xsd:boolean canViewAssignments
   Indicates that Assignments can be viewed.
FolderSecurityRoleType type
   The type of the security role.

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

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.


canBreakdownFolders


xsd:boolean  canBreakdownFolders
Indicates that Folders can be broken-down.

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.


canDeleteFolders


xsd:boolean  canDeleteFolders
Indicates that Folders 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.


canEditReqProFolder


xsd:boolean  canEditReqProFolder
Indicates that ReqProFolder 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.


canManageManualWorkflows


xsd:boolean  canManageManualWorkflows
Indicates that Workflow can be managed.

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.


canPermanentlyDeleteFolder


xsd:boolean  canPermanentlyDeleteFolder
Indicates that Folder 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.


canPublishRenderPrivateFolder


xsd:boolean  canPublishRenderPrivateFolder
Indicates that RenderPrivateFolder can be published.

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.


canRenameFolders


xsd:boolean  canRenameFolders
Indicates that Folders 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.


canTransferOrMoveScopeElementsAcrossProjects


xsd:boolean  canTransferOrMoveScopeElementsAcrossProjects
Indicates that ScopeElements can be transferred or 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.


canTransferScopeElementsToWBSView


xsd:boolean  canTransferScopeElementsToWBSView
Indicates that ScopeElements can be transferred to WBS view.

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.


type


FolderSecurityRoleType type
The type of the security role.

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.


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.