com.netscape.pm.model
Interface IHistoryEvent

public interface IHistoryEvent

Defines a history event object used to log actions performed within the Process Manager engine run-time. An object implementing the IHistoryEvent interface may be constructed by using the HistoryEventFactory class and logged to the system's back-end storage via the IProcessInstance method addHistoryEvent.

See Also:

HistoryEventFactory, IProcessInstance

Field Summary

static int	ASSIGNMENT History event type for events logged during the assignment of a work item.
static int	AUTOMATED_STEP History event type for an engine initiated action.
static int	COMPLETION History event type for events logged during the completion of a work item.
static int	DELEGATE History event type for events logged during the delegation of a work item.
static int	EXCEPTION History event type for events logged during the creation of an exception work item.
static int	EXCEPTION_EVENT History event type for an exception event.
static int	EXPIRE History event type for events logged during the expiration of a work item.
static int	EXTEND History event type for events logged during the extension of a work item's expiration date.
static int	FORCE_COMPLETION History event type for events logged during the moving of a work item from one node to another node.
static int	LOG History event type for events logged by the user for informational purposes.
static int	MANAGEMENT_EVENT History event type for an administrative action.
static int	RETRY History event type for events logged during the retrying of an exception work item.
static int	SAVE History event type for events logged during the saving of a work item.
static int	SET_EXPIRATION History event type for events logged during the setting of a work item's expiration date.
static int	START History event type for events logged during the starting of a work item.
static int	TERMINATE History event type for events logged during the termination of a process instance.
static int	USER_ACTION History event type for a user initiated action.

Method Summary

java.util.Hashtable	dumpState() Returns the properties of the history event in a hashtable.
java.lang.String	getApplicationName() Returns the name of the application the history event was logged under.
java.lang.String	getComment() Returns the user comment logged with the history event.
java.util.Date	getEventDate() Returns the date the history event was logged.
java.lang.String	getEventId() Returns the event id of the history event.
int	getEventType() Returns the type of the history event.
java.lang.String	getUserId() Returns the user id of the authenticated user that was responsible for logging this history event.
IWorkItemPK	getWIPrimaryKey() Returns the primary key of the work item used to create the history event with.

Field Detail

USER_ACTION

public static final int USER_ACTION

History event type for a user initiated action. History events of this type are logging the event as the result of a user action, for example saving or delegating a work item (events that are not performed automatically by the engine). Instead of using this event type constant, users should use the constructor level event types such as COMPLETION and SAVE to make their code more readable.

Since:

PAE 4.0

AUTOMATED_STEP

public static final int AUTOMATED_STEP

History event type for an engine initiated action. History events of this type are logged by the engine whenever an action is undertaken automatically without any initiation by the user (for example, the performing and completion of an automated node).

Since:

PAE 4.0

MANAGEMENT_EVENT

public static final int MANAGEMENT_EVENT

History event type for an administrative action. History events of this type are logged by the engine whenever an action involving the administration of a work item or process instance is undertaken (for example, terminating a process instance or moving a work item to another node).

Since:

PAE 4.0

EXCEPTION_EVENT

public static final int EXCEPTION_EVENT

History event type for an exception event. History events of this type are logged by the engine whenever an exception work item has been created.

Since:

PAE 4.0

ASSIGNMENT

public static final int ASSIGNMENT

History event type for events logged during the assignment of a work item. Users should use this event type rather than USER_ACTION, even though both values are equivalent as using this value should make code more readable.

See Also:

USER_ACTION

Since:

PM 6.0

COMPLETION

public static final int COMPLETION

History event type for events logged during the completion of a work item. Users should use this event type rather than USER_ACTION, even though both values are equivalent as using this value should make code more readable.

See Also:

USER_ACTION

Since:

PM 6.0

SAVE

public static final int SAVE

History event type for events logged during the saving of a work item. Users should use this event type rather than USER_ACTION, even though both values are equivalent as using this value should make code more readable.

See Also:

USER_ACTION

Since:

PM 6.0

START

public static final int START

History event type for events logged during the starting of a work item. Users should use this event type rather than USER_ACTION, even though both values are equivalent as using this value should make code more readable.

See Also:

USER_ACTION

Since:

PM 6.0

DELEGATE

public static final int DELEGATE

History event type for events logged during the delegation of a work item. Users should use this event type rather than USER_ACTION, even though both values are equivalent as using this value should make code more readable.

See Also:

USER_ACTION

Since:

PM 6.0

EXCEPTION

public static final int EXCEPTION

History event type for events logged during the creation of an exception work item. Users should use this event type rather than EXCEPTION_EVENT, even though both values are equivalent as using this value should make code more readable.

See Also:

EXCEPTION_EVENT

Since:

PM 6.0

TERMINATE

public static final int TERMINATE

History event type for events logged during the termination of a process instance. Users should use this event type rather than MANAGEMENT_EVENT, even though both values are equivalent as using this value should make code more readable.

See Also:

MANAGEMENT_EVENT

Since:

PM 6.0

SET_EXPIRATION

public static final int SET_EXPIRATION

History event type for events logged during the setting of a work item's expiration date. Users should use this event type rather than USER_ACTION, even though both values are equivalent as using this value should make code more readable.

See Also:

USER_ACTION

Since:

PM 6.0

EXPIRE

public static final int EXPIRE

History event type for events logged during the expiration of a work item. Users should use this event type rather than AUTOMATED_STEP, even though both values are equivalent as using this value should make code more readable.

See Also:

AUTOMATED_STEP

Since:

PM 6.0

EXTEND

public static final int EXTEND

History event type for events logged during the extension of a work item's expiration date. Users should use this event type rather than USER_ACTION, even though both values are equivalent as using this value should make code more readable.

See Also:

USER_ACTION

Since:

PM 6.0

RETRY

public static final int RETRY

History event type for events logged during the retrying of an exception work item. Users should use this event type rather than USER_ACTION, even though both values are equivalent as using this value should make code more readable.

See Also:

USER_ACTION

Since:

PM 6.0

FORCE_COMPLETION

public static final int FORCE_COMPLETION

History event type for events logged during the moving of a work item from one node to another node. This action is considered a management event since moving a work item to another node not connected to it via a transition is not considered part of the normal flow of a process. Users should use this event type rather than MANAGEMENT_EVENT, even though both values are equivalent as using this value should make code more readable.

See Also:

MANAGEMENT_EVENT

Since:

PM 6.0

LOG

public static final int LOG

History event type for events logged by the user for informational purposes. Users should use this event type rather than MANAGEMENT_EVENT, even though both values are equivalent as using this value should make code more readable.

See Also:

MANAGEMENT_EVENT

Since:

PM 6.0

Method Detail

getEventId

public java.lang.String getEventId()

Returns the event id of the history event. The event id is the primary description associated with an event. For example, the history event logged during the saving of a work item could have an event id of:

Workitem saved by admin

Returns:

the event id of the history event.

Since:

PM 6.0

getEventDate

public java.util.Date getEventDate()

Returns the date the history event was logged.

Returns:

the date the history event was logged.

Since:

PM 6.0

getEventType

public int getEventType()

Returns the type of the history event.

Returns:

Since:

PM 6.0

See Also:

USER_ACTION, AUTOMATED_STEP, MANAGEMENT_EVENT, EXCEPTION_EVENT

getWIPrimaryKey

public IWorkItemPK getWIPrimaryKey()

Returns the primary key of the work item used to create the history event with.

Returns:

the primary key of the work item associated with the history event.

Since:

PM 6.0

See Also:

IWorkItemPK

getUserId

public java.lang.String getUserId()

Returns the user id of the authenticated user that was responsible for logging this history event.

Returns:

the authenticated user id of the user who logged this event.

Since:

PM 6.0

getComment

public java.lang.String getComment()

Returns the user comment logged with the history event.

Returns:

the user comment logged with the history event.

Since:

PM 6.0

See Also:

HistoryEventFactory.create( IWorkItem, String, String )

getApplicationName

public java.lang.String getApplicationName()

Returns the name of the application the history event was logged under.

Returns:

the name of the application the history event belongs to.

Since:

PM 6.0

dumpState

public java.util.Hashtable dumpState()

Returns the properties of the history event in a hashtable. This method was designed to be used as a debugging tool; it presents users with a simple means of checking the current state of a history event object.

Returns:

the properties of the history event

Since:

PM 6.0