Base Event Interfaces
Each idmgr event object implements one or at most two of the base event interfaces listed in the following table:
cim1265
Each event object implements one or at most two of the base event interfaces listed in the following table:
For more information on these components, refer to the Programming Reference.
Base Interface | Method | Managed Object Retrieved |
AccessRoleEvent | getAccessRole() | AccessRole |
getAccessTask() | AccessTask | |
AdminRoleEvent | getAdminRole() | AdminRole |
AdminTaskEvent | getAdminTask() | AdminTask |
GroupEvent | getGroup() | Group |
OrganizationEvent | getOrganization() | Organization |
ParentOrganizationEvent | getParentOrganization() | Organization |
ProvisioningRoleEvent | getProvisioningRole() | ProvisioningRole |
UserEvent | getUser() | User |
Note:
Base event interfaces are not events. events implement the base event interfaces.Most base event interfaces contain a single get... method, which retrieves the managed object contained in the event. For example, AccessRoleEvent contains a getAccessRole() method that returns an AccessRole managed object. The exception is ExternalTaskEvent. Because external tasks are executed by third-party applications, ExternalTaskEvent contains no get... method for retrieving a managed object.
When a custom object or a workflow script retrieves the current event object, the get... methods that the event object inherits from the base interfaces can retrieve the managed objects contained in the event.
The get... methods that a particular event object inherits are determined by the base interfaces that the event object implements. For example:
- A CreateAdminRoleEvent object implements a single base interface -- AdminRoleEvent. The getAdminRole() method that CreateAdminRoleEvent inherits allows a custom object or script to retrieve an AdminRole managed object.
- A CreateUserEvent object implements the base interfaces UserEvent (for the user being created) and ParentOrganizationEvent (for the organization where the user is being created). Therefore, the CreateUserEvent object inherits the following methods:
- getUser(), for retrieving a User managed object
- getParentOrganization(), for retrieving the Organization managed object