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

```
public interface AuditEventGroupManager
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AuditEventGroupManagerResult`	`addEntityTypeAction(java.lang.String groupId, java.lang.String entityTypeActionId, java.util.HashMap relationAttrs)` Create an AuditEventGroupEntityTypeAction relationship.
`AuditEventGroupManagerResult`	`create(AuditEventGroup auditEventGroup)` Create an AuditEventGroup.
`AuditEventGroupManagerResult`	`delete(java.lang.String groupId)` Delete an AuditEventGroup and all associated AuditEventGroupEntityTypeActions.
`java.util.List`	`getAuditEventGroupEntityTypeActions(SearchCriteria filter, java.util.Set retAttrs, java.util.Map configParams)` Search AuditEventGroupEntityTypeAction relations.
`AuditEventGroup`	`getDetails(java.lang.String groupId, java.util.Set retAttrs)` Returns details of an AuditEventGroup matching the specified entity identifier.
`java.lang.Boolean`	`isAuditEnabled(AuditEvent auditEvent)` Determine if auditing is enabled for the specifed audit event
`AuditEventGroupManagerResult`	`modify(AuditEventGroup auditEventGroup)` Modify the AuditEventGroup attributes in the specified AuditEventGroup.
`AuditEventGroupManagerBulkRelationResult`	`removeEntityTypeActionByAction(java.lang.String actionId)` Delete AuditEventGroupEntityTypeActions by entity type action id
`AuditEventGroupManagerBulkRelationResult`	`removeEntityTypeActionByGroup(java.lang.String groupId)` Delete AuditEventGroupEntityTypeActions by groupId
`AuditEventGroupManagerBulkRelationResult`	`removeEntityTypeActions(SearchCriteria filter)` Delete AuditEventGroupEntityTypeActions
`java.util.List`	`search(SearchCriteria sc, java.util.Set retAttrs, java.util.Map config)` Searches all AuditEventGroups that match the specified search criteria.

Method Detail

getDetails
```
AuditEventGroup getDetails(java.lang.String groupId,
                           java.util.Set retAttrs)
                    throws ValidationFailedException,
                           oracle.iam.platform.entitymgr.NoSuchEntityException,
                           AccessDeniedException,
                           EntitySearchException
```
Returns details of an AuditEventGroup matching the specified entity identifier.

Parameters:

groupId - AuditEventGroup identifier

retAttrs - set of attributes in Audit Event Group to return

Returns:

AuditEventGroup matching groupId

Throws:

ValidationFailedException - If retAttrs contains an invalid attribute name

oracle.iam.platform.entitymgr.NoSuchEntityException - If the entity type is not defined

AccessDeniedException - In case user doesn't have authorization to view AuditEventGroups

EntitySearchException - If a ProviderException is thrown from EM

search
```
java.util.List search(SearchCriteria sc,
                      java.util.Set retAttrs,
                      java.util.Map config)
               throws EntitySearchException,
                      AccessDeniedException,
                      oracle.iam.platform.entitymgr.NoSuchEntityException,
                      ValidationFailedException
```
Searches all AuditEventGroups that match the specified search criteria.

Parameters:

sc - search criteria to use in search

retAttrs - set of attributes in Audit Event Group to return

config - configuration options such as pagination and sorting

Returns:

list of AuditEventGroups matching search criteria

Throws:

EntitySearchException - If a ProviderException is thrown from EM

AccessDeniedException - In case user doesn't have authorization to view AuditEventGroups

oracle.iam.platform.entitymgr.NoSuchEntityException - If the entity type is not defined

ValidationFailedException - If retAttrs contains an invalid attribute name

create
```
AuditEventGroupManagerResult create(AuditEventGroup auditEventGroup)
                             throws ValidationFailedException,
                                    EntityAlreadyExistsException,
                                    EntityCreateException,
                                    AccessDeniedException
```
Create an AuditEventGroup.

Parameters:

auditEventGroup - the AuditEventGroup entity

Returns:

AuditEventGroupManagerResult result that contains AuditEventGroup id of the newly created AuditEventGroup

Throws:

ValidationFailedException - If one or more attributes in the auditEventGroup is not defined for the entity type

EntityAlreadyExistsException

EntityCreateException - If any exception is thrown by the EM

AccessDeniedException - In case user doesn't have authorization to create AuditEventGroups

modify

AuditEventGroupManagerResult modify(AuditEventGroup auditEventGroup)
                             throws ValidationFailedException,
                                    EntityModifyException,
                                    oracle.iam.platform.entitymgr.NoSuchEntityException,
                                    AccessDeniedException,
                                    EntityLockedException,
                                    oracle.iam.platform.entitymgr.InvalidDataTypeException,
                                    oracle.iam.platform.entitymgr.StaleEntityException,
                                    oracle.iam.platform.entitymgr.InvalidDataFormatException,
                                    oracle.iam.platform.entitymgr.UnsupportedOperationException,
                                    oracle.iam.platform.entitymgr.UnknownAttributeException,
                                    oracle.iam.platform.entitymgr.ProviderException

Modify the AuditEventGroup attributes in the specified AuditEventGroup. The AuditEventGroup must contain an AuditEventGroup id.

Parameters:: auditEventGroup - The AuditEventGroup entity with modified attribute values
Returns:: AuditEventGroupManagerResult Result of the AuditEventGroup modify operation
Throws:: ValidationFailedException; EntityModifyException; oracle.iam.platform.entitymgr.NoSuchEntityException; AccessDeniedException; EntityLockedException; oracle.iam.platform.entitymgr.InvalidDataTypeException; oracle.iam.platform.entitymgr.StaleEntityException; oracle.iam.platform.entitymgr.InvalidDataFormatException; oracle.iam.platform.entitymgr.UnsupportedOperationException; oracle.iam.platform.entitymgr.UnknownAttributeException; oracle.iam.platform.entitymgr.ProviderException

delete

AuditEventGroupManagerResult delete(java.lang.String groupId)
                             throws EntityDeleteException,
                                    oracle.iam.platform.entitymgr.NoSuchEntityException,
                                    AccessDeniedException,
                                    ValidationFailedException,
                                    EntityLockedException

Delete an AuditEventGroup and all associated AuditEventGroupEntityTypeActions.

Parameters:: groupId - AuditEventGroup Id
Returns:: AuditEventGroupManagerResult result of the AuditEventGroup delete
Throws:: ValidationFailedException; EntityDeleteException; oracle.iam.platform.entitymgr.NoSuchEntityException; AccessDeniedException; EntityLockedException

addEntityTypeAction

AuditEventGroupManagerResult addEntityTypeAction(java.lang.String groupId,
                                                 java.lang.String entityTypeActionId,
                                                 java.util.HashMap relationAttrs)
                                          throws ValidationFailedException,
                                                 EntityModifyException,
                                                 oracle.iam.platform.entitymgr.NoSuchEntityException,
                                                 AccessDeniedException,
                                                 EntityLockedException

Create an AuditEventGroupEntityTypeAction relationship.

Parameters:: groupId - AuditEventGroup Id; entityTypeActionId - AuditEventEntityTypeAction Id
Returns:: AuditEventGroupManagerResult result of the AuditEventGroupEntityTypeActioncreate operation
Throws:: EntityModifyException; oracle.iam.platform.entitymgr.NoSuchEntityException; AccessDeniedException; ValidationFailedException; EntityLockedException

getAuditEventGroupEntityTypeActions

java.util.List getAuditEventGroupEntityTypeActions(SearchCriteria filter,
                                                   java.util.Set retAttrs,
                                                   java.util.Map configParams)
                                            throws ValidationFailedException,
                                                   oracle.iam.platform.entitymgr.NoSuchEntityException,
                                                   AccessDeniedException,
                                                   EntitySearchException

Search AuditEventGroupEntityTypeAction relations.

Parameters:: filter - Search criteria; retAttrs - Return attribute names; configParams - Sorting and paging parameters
Returns:: AuditEventGroupEntityTypeAction Search results
Throws:: oracle.iam.platform.entitymgr.NoSuchEntityException; AccessDeniedException; ValidationFailedException; EntitySearchException

removeEntityTypeActionByGroup

AuditEventGroupManagerBulkRelationResult removeEntityTypeActionByGroup(java.lang.String groupId)
                                                                throws ValidationFailedException,
                                                                       EntityModifyException,
                                                                       oracle.iam.platform.entitymgr.NoSuchEntityException,
                                                                       AccessDeniedException

Delete AuditEventGroupEntityTypeActions by groupId

Parameters:: groupId - Unique identifier of group
Returns:: AuditEventGroupManagerBulkRelationResult Result of delete operation
Throws:: EntityModifyException; oracle.iam.platform.entitymgr.NoSuchEntityException - if group cannot be found; AccessDeniedException - if logged in user does not have permission to delete the group; ValidationFailedException

removeEntityTypeActionByAction

AuditEventGroupManagerBulkRelationResult removeEntityTypeActionByAction(java.lang.String actionId)
                                                                 throws ValidationFailedException,
                                                                        EntityModifyException,
                                                                        oracle.iam.platform.entitymgr.NoSuchEntityException,
                                                                        AccessDeniedException

Delete AuditEventGroupEntityTypeActions by entity type action id

Parameters:: actionId - Unique identifier of entity type action
Returns:: AuditEventGroupManagerBulkRelationResult Result of delete operation
Throws:: EntityModifyException; oracle.iam.platform.entitymgr.NoSuchEntityException; AccessDeniedException; ValidationFailedException

removeEntityTypeActions

AuditEventGroupManagerBulkRelationResult removeEntityTypeActions(SearchCriteria filter)
                                                          throws EntityModifyException,
                                                                 ValidationFailedException,
                                                                 oracle.iam.platform.entitymgr.NoSuchEntityException,
                                                                 AccessDeniedException

Delete AuditEventGroupEntityTypeActions

Parameters:: filter - Search criteria for relations to be deleted
Returns:: AuditEventGroupManagerBulkRelationResult Result of delete operation
Throws:: EntityModifyException; oracle.iam.platform.entitymgr.NoSuchEntityException; AccessDeniedException; ValidationFailedException

isAuditEnabled

java.lang.Boolean isAuditEnabled(AuditEvent auditEvent)
                          throws EntitySearchException,
                                 AccessDeniedException,
                                 oracle.iam.platform.entitymgr.NoSuchEntityException,
                                 ValidationFailedException

Determine if auditing is enabled for the specifed audit event

Parameters:: auditEvent - The audit event to be evaluated
Returns:: AuditEventGroupManagerBulkRelationResult Result of delete operation
Throws:: EntitySearchException; oracle.iam.platform.entitymgr.NoSuchEntityException; AccessDeniedException; ValidationFailedException

Interface AuditEventGroupManager