RuleManager (Oracle Fusion Middleware Java API Reference for Oracle Identity Manager)

```
public interface RuleManager
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addReturnValue(java.lang.String ruleId, ReturnValue rv)` Add the return value parameter to the specified rule entity id.
`void`	`addReturnValues(java.lang.String ruleId, java.util.Set rvs)` Add the the set of return values to the rule matching the rule entity id.
`RuleManagerResult`	`create(Rule entity)` Create a rule using specified rule.
`RuleManagerResult`	`delete(java.lang.String entityId)` Delete the rule and all policy association relationships, i.e.
`RuleManagerResult`	`disable(java.lang.String ruleId)` Disaable the rule associated with the specified rule entity id.
`RuleManagerResult`	`enable(java.lang.String ruleId)` Enable the rule associated with the specified rule entity id.
`java.util.List`	`getAssignedPolicies(java.lang.String ruleId, java.util.Set retAttrs, java.util.HashMap configParams)` Retrieve list of policies assigned to the rule specified by the rule entity id.
`Rule`	`getDetails(java.lang.String entityId, java.util.Set retAttrs)` Retrieve the attributes of the rule specified by the rule entity id.
`ReturnValue`	`getReturnValue(java.lang.String ruleId, java.lang.String returnValueId, java.util.Set retAttrs)` Retrieve the return value matching both the specified rule entity id and the return value entity id.
`java.util.List`	`getReturnValues(java.lang.String ruleId, SearchCriteria sc, java.util.Set retAttrs, java.util.HashMap configParams)` Retrieve the list of return values in the specified rule entity id that match the search criteria parameter.
`RuleManagerResult`	`lock(java.lang.String ruleId)` Lock the rule associated with the specified rule entity id.
`RuleManagerResult`	`modify(Rule entity)` Modify the rule attributes in the specified rule entity.
`void`	`modifyReturnValue(java.lang.String returnValueId, ReturnValue rv)` Modify the return value specified by rule entity id.
`void`	`modifyReturnValues(java.lang.String ruleId, java.util.Set rvs)` Modify the return values matching both the specified rule entity id and the set of return values.
`void`	`removeReturnValue(java.lang.String ruleId, java.lang.String returnValueId)` Remove the return value matching both the specified rule entity id and return value id.
`void`	`removeReturnValues(java.lang.String ruleId, java.util.List returnValueIds)` Remove the return value entity ids matching both the specified rule entity id and list of return value ids.
`void`	`replaceReturnValues(java.lang.String ruleId, java.util.List rvs)` Replace the return values of the rule specified by the rule entity id with the list of return values parameter.
`java.util.List`	`search(SearchCriteria sc, java.util.Set retAttrs, java.util.Map config)` Search for the rules in the system that match the specified search criteria.
`RuleManagerResult`	`unlock(java.lang.String ruleId)` Unlock the rule associated with the specified rule entity id.

Method Detail

create

RuleManagerResult create(Rule entity)
                  throws ValidationFailedException,
                         EntityAlreadyExistsException,
                         EntityCreateException,
                         AccessDeniedException

Create a rule using specified rule.

Parameters:: entity - the rule entity
Returns:: RuleManagerResult result that contains rule entity id of the newly created rule
Throws:: ValidationFailedException; EntityAlreadyExistsException; EntityCreateException; AccessDeniedException

modify

RuleManagerResult modify(Rule entity)
                  throws ValidationFailedException,
                         EntityModifyException,
                         oracle.iam.platform.entitymgr.NoSuchEntityException,
                         AccessDeniedException,
                         EntityLockedException

Modify the rule attributes in the specified rule entity. The rule entity must constain an rule entity id.

Parameters:: entity - the rule entity
Returns:: RuleManagerResult result of the rule modify
Throws:: ValidationFailedException; EntityModifyException; oracle.iam.platform.entitymgr.NoSuchEntityException; AccessDeniedException; EntityLockedException

delete
```
RuleManagerResult delete(java.lang.String entityId)
                  throws EntityDeleteException,
                         oracle.iam.platform.entitymgr.NoSuchEntityException,
                         AccessDeniedException,
                         ValidationFailedException,
                         EntityLockedException
```
Delete the rule and all policy association relationships, i.e. remove from policies.

Parameters:

entityId - rule entity Id

Returns:

RuleManagerResult result of the rule delete

Throws:

EntityDeleteException, - NoSuchEntityException, AccessDeniedException, ValidationFailedException, EntityLockedException

EntityDeleteException

oracle.iam.platform.entitymgr.NoSuchEntityException

AccessDeniedException

ValidationFailedException

EntityLockedException

getDetails
```
Rule getDetails(java.lang.String entityId,
                java.util.Set retAttrs)
         throws oracle.iam.platform.entitymgr.NoSuchEntityException,
                AccessDeniedException,
                EntitySearchException,
                ValidationFailedException
```
Retrieve the attributes of the rule specified by the rule entity id. The retAttrs parameter specifies the attribute set to be returned.

Parameters:

entityId - the rule entity id

retAttrs - the attributes of the rule to be returned

Returns:

Rule entity associated with the rule entity id

Throws:

oracle.iam.platform.entitymgr.NoSuchEntityException

AccessDeniedException

EntitySearchException

ValidationFailedException

search
```
java.util.List search(SearchCriteria sc,
                      java.util.Set retAttrs,
                      java.util.Map config)
               throws EntitySearchException,
                      AccessDeniedException,
                      oracle.iam.platform.entitymgr.NoSuchEntityException,
                      ValidationFailedException
```
Search for the rules in the system that match the specified search criteria. The retAttrs parameter specifies the attribute set to be returned. The config map can used to define parameters such as pagination and sorting.

Parameters:

sc - the search criteria

retAttrs - set of attributes of the rule to return

config - map of configuration parameters

Returns:

list of rule entities matching the search criteria

Throws:

EntitySearchException

AccessDeniedException

oracle.iam.platform.entitymgr.NoSuchEntityException

ValidationFailedException

lock

RuleManagerResult lock(java.lang.String ruleId)
                throws ValidationFailedException,
                       oracle.iam.platform.entitymgr.NoSuchEntityException,
                       AccessDeniedException,
                       EntityLockException

Lock the rule associated with the specified rule entity id.

Parameters:: ruleId - the rule entity id to lock
Returns:: RuleManagerResult result of rule lock
Throws:: ValidationFailedException; oracle.iam.platform.entitymgr.NoSuchEntityException; AccessDeniedException; EntityLockException

unlock

RuleManagerResult unlock(java.lang.String ruleId)
                  throws ValidationFailedException,
                         oracle.iam.platform.entitymgr.NoSuchEntityException,
                         AccessDeniedException,
                         EntityLockException

Unlock the rule associated with the specified rule entity id.

Parameters:: ruleId - the rule entity id to unlock
Returns:: RuleManagerResult result of rule unlock
Throws:: ValidationFailedException; oracle.iam.platform.entitymgr.NoSuchEntityException; AccessDeniedException; EntityLockException

enable

RuleManagerResult enable(java.lang.String ruleId)
                  throws ValidationFailedException,
                         EntityDisableException,
                         oracle.iam.platform.entitymgr.NoSuchEntityException,
                         AccessDeniedException,
                         EntitySearchException,
                         EntityModifyException,
                         EntityLockedException

Enable the rule associated with the specified rule entity id.

Parameters:: ruleId - the rule entity id to enable
Returns:: RuleManagerResult result of rule enable
Throws:: ValidationFailedException; EntityDisableException; oracle.iam.platform.entitymgr.NoSuchEntityException; AccessDeniedException; EntitySearchException; EntityModifyException; EntityLockedException

disable

RuleManagerResult disable(java.lang.String ruleId)
                   throws ValidationFailedException,
                          EntityDisableException,
                          oracle.iam.platform.entitymgr.NoSuchEntityException,
                          AccessDeniedException,
                          EntitySearchException,
                          EntityModifyException,
                          EntityLockedException

Disaable the rule associated with the specified rule entity id.

Parameters:: ruleId - the rule entity id to disable
Returns:: RuleManagerResult result of rule disable
Throws:: ValidationFailedException; EntityDisableException; oracle.iam.platform.entitymgr.NoSuchEntityException; AccessDeniedException; EntitySearchException; EntityModifyException; EntityLockedException

getAssignedPolicies

java.util.List getAssignedPolicies(java.lang.String ruleId,
                                   java.util.Set retAttrs,
                                   java.util.HashMap configParams)
                            throws RuleManagerException,
                                   EntitySearchException,
                                   AccessDeniedException,
                                   oracle.iam.platform.entitymgr.NoSuchEntityException,
                                   ValidationFailedException

Retrieve list of policies assigned to the rule specified by the rule entity id. The retAttrs parameter specifies the attribute set to be returned.

Parameters:: ruleId - the rule entity id; retAttrs -; configParams -
Returns:
Throws:: RuleManagerException; EntitySearchException; AccessDeniedException; oracle.iam.platform.entitymgr.NoSuchEntityException; ValidationFailedException

getReturnValue
```
ReturnValue getReturnValue(java.lang.String ruleId,
                           java.lang.String returnValueId,
                           java.util.Set retAttrs)
                    throws oracle.iam.platform.entitymgr.NoSuchEntityException,
                           EntitySearchException,
                           ValidationFailedException
```
Retrieve the return value matching both the specified rule entity id and the return value entity id. The retAttrs parameter can specify which return value attributes to return.

Parameters:

ruleId - the rule entity id

returnValueId - the return value entity id

retAttrs -

Returns:

the matching return value

Throws:

oracle.iam.platform.entitymgr.NoSuchEntityException

EntitySearchException

ValidationFailedException

getReturnValues

java.util.List getReturnValues(java.lang.String ruleId,
                               SearchCriteria sc,
                               java.util.Set retAttrs,
                               java.util.HashMap configParams)
                        throws oracle.iam.platform.entitymgr.NoSuchEntityException,
                               EntitySearchException,
                               ValidationFailedException

Retrieve the list of return values in the specified rule entity id that match the search criteria parameter. The retAttrs parameter can specify which return value attributes to return.

Parameters:: ruleId - the rule entity id; sc - the search criteria to match; retAttrs - set of return value attributes to return; configParams - config params
Returns:
Throws:: oracle.iam.platform.entitymgr.NoSuchEntityException; EntitySearchException; ValidationFailedException

addReturnValue

void addReturnValue(java.lang.String ruleId,
                    ReturnValue rv)
             throws oracle.iam.platform.entitymgr.NoSuchEntityException,
                    EntityModifyException,
                    ValidationFailedException,
                    EntityLockedException

Add the return value parameter to the specified rule entity id.

Parameters:: ruleId - the rule entity id; rv - the return value
Throws:: oracle.iam.platform.entitymgr.NoSuchEntityException; EntityModifyException; ValidationFailedException; EntityLockedException

addReturnValues

void addReturnValues(java.lang.String ruleId,
                     java.util.Set rvs)
              throws oracle.iam.platform.entitymgr.NoSuchEntityException,
                     EntityModifyException,
                     ValidationFailedException,
                     EntityLockedException

Add the the set of return values to the rule matching the rule entity id.

Parameters:: ruleId - the rule entity id; rvs -
Throws:: oracle.iam.platform.entitymgr.NoSuchEntityException; EntityModifyException; ValidationFailedException; EntityLockedException

modifyReturnValue

void modifyReturnValue(java.lang.String returnValueId,
                       ReturnValue rv)
                throws oracle.iam.platform.entitymgr.NoSuchEntityException,
                       ValidationFailedException,
                       EntityModifyException,
                       EntityLockedException

Modify the return value specified by rule entity id.

Parameters:: returnValueId - the return value entity id; rv - set of return values
Throws:: oracle.iam.platform.entitymgr.NoSuchEntityException; ValidationFailedException; EntityModifyException; EntityLockedException

modifyReturnValues

void modifyReturnValues(java.lang.String ruleId,
                        java.util.Set rvs)
                 throws oracle.iam.platform.entitymgr.NoSuchEntityException,
                        ValidationFailedException,
                        EntityModifyException,
                        EntityLockedException

Modify the return values matching both the specified rule entity id and the set of return values.

Parameters:: ruleId - the rule entity id; rvs - the return value to modify
Throws:: oracle.iam.platform.entitymgr.NoSuchEntityException; ValidationFailedException; EntityModifyException; EntityLockedException

removeReturnValue

void removeReturnValue(java.lang.String ruleId,
                       java.lang.String returnValueId)
                throws oracle.iam.platform.entitymgr.NoSuchEntityException,
                       EntityModifyException,
                       EntityLockedException

Remove the return value matching both the specified rule entity id and return value id.

Parameters:: ruleId - the rule entity id; returnValueId - the return value entity id
Throws:: oracle.iam.platform.entitymgr.NoSuchEntityException; EntityModifyException; EntityLockedException

removeReturnValues

void removeReturnValues(java.lang.String ruleId,
                        java.util.List returnValueIds)
                 throws oracle.iam.platform.entitymgr.NoSuchEntityException,
                        EntityModifyException,
                        EntityLockedException

Remove the return value entity ids matching both the specified rule entity id and list of return value ids.

Parameters:: ruleId - the rule entity id; returnValueIds - list of return value entity ids
Throws:: oracle.iam.platform.entitymgr.NoSuchEntityException; EntityModifyException; EntityLockedException

replaceReturnValues
```
void replaceReturnValues(java.lang.String ruleId,
                         java.util.List rvs)
                  throws RuleManagerException
```
Replace the return values of the rule specified by the rule entity id with the list of return values parameter. All of the return values for a the rule are replaced by the contents of the list.

Parameters:

ruleId - the rule entity id

rvs - list of return values

Throws:

RuleManagerException

Interface RuleManager