RoleManager (Oracle Role Manager API Reference)

Method Summary
`oracle.iam.rm.common.PaginatedResultSet`	`findBusinessRoles(Filter filter, ColumnSetDef columnSetDef)` Returns a set of Business roles that meets the specified filter criteria.
`oracle.iam.rm.common.PaginatedResultSet`	`findITRoles(Filter filter, ColumnSetDef columnSetDef)` Returns a set of IT roles that meets the specified filter criteria.
`java.util.List<ITRole>`	`findMappedITRoles(BusinessRole businessRole)` Returns a list of ITRoles that are mapped to the provided BusinessRole.
`Person`	`findRoleOwner(Role role)` Gets the owner of the provided role.
`BusinessRole`	`getBusinessRole(ObjectKey objectKey)` Gets the BusinessRole identified by the provided object key.
`int`	`getGrantCount(Role role)` Returns the number of role grants associated with the provided role.
`java.util.List<SnapshotObject>`	`getGrantSOCBindings(RoleGrant roleGrant)` Returns a list of SnapshotObjects that represent the sphere of control for the role.
`ITRole`	`getITRole(ObjectKey objectKey)` Gets the ITRole identified by the provided object key.
`RoleGrant`	`getRoleGrant(Role role, User user)` Returns the RoleGrant instance for the specified role granted to the specified user or null if no such grant exists.
`java.lang.String`	`getSocHierarchyType(Role role)` Returns a String that is the SOC hierarchy type associated with the role, or null if the role does not have an SOC hierarchy.
`boolean`	`hasGrantSOCBinding(RoleGrant roleGrant, SnapshotObject socSubject)` Returns a flag indicating whether a particular SOC has been associated to a role grant.

Methods inherited from interface oracle.iam.rm.temporal.SnapshotSession
`canEdit, findObjectKeys, findSnapshotObjects, getObjectType, getObjectType, getSnapshotObject, getTemporalEngine`

Method Detail

findITRoles

oracle.iam.rm.common.PaginatedResultSet findITRoles(Filter filter,
                                                    ColumnSetDef columnSetDef)
                                                    throws TemporalException

Returns a set of IT roles that meets the specified filter criteria.

Parameters:: filter - search criteria; columnSetDef - set of attributes to be returned
Returns:: PaginatedResultSet containing zero or more rows.
Throws:: TemporalException - if a system error occurs.

getITRole

ITRole getITRole(ObjectKey objectKey)
                 throws TemporalException

Gets the ITRole identified by the provided object key.

Parameters:: objectKey - key of ITRole to get
Returns:: ITRole identified by the provided key
Throws:: TemporalException - if a system error occurs.

findBusinessRoles

oracle.iam.rm.common.PaginatedResultSet findBusinessRoles(Filter filter,
                                                          ColumnSetDef columnSetDef)
                                                          throws TemporalException

Returns a set of Business roles that meets the specified filter criteria.

Parameters:: filter - search criteria; columnSetDef - set of attributes to be returned
Returns:: PaginatedResultSet containing zero or more rows.
Throws:: TemporalException - if a system error occurs.

getBusinessRole

BusinessRole getBusinessRole(ObjectKey objectKey)
                             throws TemporalException

Gets the BusinessRole identified by the provided object key.

Parameters:: objectKey - key of BusinessRole to get
Returns:: BusinessRole identified by the provided key
Throws:: TemporalException - if a system error occurs.

findMappedITRoles

java.util.List<ITRole> findMappedITRoles(BusinessRole businessRole)
                                         throws TemporalException

Returns a list of ITRoles that are mapped to the provided BusinessRole.

Parameters:: businessRole - an existing BusinessRole instance
Returns:: List of zero or more mapped ITRoles
Throws:: TemporalException - if a system error occurs.

findRoleOwner

Person findRoleOwner(Role role)
                     throws TemporalException

Gets the owner of the provided role.

Parameters:: role - any existing role instance
Returns:: The Person representing the role owner of the provided role
Throws:: TemporalException - if a system error occurs.

getGrantCount

int getGrantCount(Role role)
                  throws TemporalException

Returns the number of role grants associated with the provided role.

Parameters:: role - an existing role instance of role grants to count
Returns:: The number of role grants of the provided role.
Throws:: TemporalException - if a system error occurs.

getRoleGrant

RoleGrant getRoleGrant(Role role,
                       User user)

Returns the RoleGrant instance for the specified role granted to the specified user or null if no such grant exists.

Parameters:: role - any role instance; user - user representing grantee
Returns:: a RoleGrant instance or null if the grant doesn't exist

getGrantSOCBindings

java.util.List<SnapshotObject> getGrantSOCBindings(RoleGrant roleGrant)

Returns a list of SnapshotObjects that represent the sphere of control for the role. The list will contain zero or more elements. The returned SnapshotObjects are the hierarchy mix-in objects.

Parameters:: roleGrant - an existing role grant
Returns:: List of SnapshotObjects of type <h>Index (the hierarchy mixin) where <h> is a hierarchy type.

getSocHierarchyType

java.lang.String getSocHierarchyType(Role role)

Returns a String that is the SOC hierarchy type associated with the role, or null if the role does not have an SOC hierarchy.

Parameters:: role - any role type
Returns:: a String containing a hierarchy type name, or null

hasGrantSOCBinding

boolean hasGrantSOCBinding(RoleGrant roleGrant,
                           SnapshotObject socSubject)

Returns a flag indicating whether a particular SOC has been associated to a role grant.

Parameters:: roleGrant - an existing role grant; socSubject - object whose SOC binding is to be established
Returns:: true if the subject has already been bound to the grant, false otherwise.