com.netegrity.imapi
Interface IMEvent

All Known Subinterfaces:

AccessRoleEvent, AccessTaskEvent, AdminRoleEvent, AdminTaskEvent, AuditEvent, ExternalTaskEvent, GroupEvent, IdentityPolicySetEvent, OrganizationEvent, ParentOrganizationEvent, ProvisioningRoleEvent, UserEvent, ViewTaskEvent

All Known Implementing Classes:

GenericAuditEvent

public interface IMEvent

A base interface for an event. A custom object or workflow script can retrieve the IMEvent object for the current event, and then cast the object as the particular event.

For information on retrieving an event object and casting it as a particular event, see Retrieving Event Objects in the Programming Guide.

Since:

IdentityMinder 5.6

Method Summary

java.lang.String	getDescription() Retrieves the description of the event.
java.lang.String	getEventName() Retrieves the event name.
java.lang.String	getSourceID() Retrieves the unique source ID of the event.
java.lang.String	getSourceName() Retrieves the unique source name of the event.
ChangeActionSource	getSourceType() Retrieves the source type of the event.
boolean	isSystemGenerated() Indicates whether the event is system generated.

Method Detail

getEventName

java.lang.String getEventName()

Retrieves the event name.

Returns:

The event name.

getDescription

java.lang.String getDescription()

Retrieves the description of the event.

Returns:

The description of the event.

isSystemGenerated

boolean isSystemGenerated()

Indicates whether the event is system generated.

Returns:

true if the event is system generated; false otherwise.

Since:

Identity Manager 8.1

getSourceType

ChangeActionSource getSourceType()

Retrieves the source type of the event. Events generated by the identity policy evaluation are system generated. Events generated as a result of manual task execution are not system generated.

Returns:

A ChangeActionSource object for a system generated event; null for non-system generated events.

Since:

Identity Manager 8.1

getSourceID

java.lang.String getSourceID()

Retrieves the unique source ID of the event.

Returns:

A String containing the ID; null for non-system generated events.

Since:

Identity Manager 8.1

getSourceName

java.lang.String getSourceName()

Retrieves the unique source name of the event.

Since:

Identity Manager 8.1