org.enhydra.shark.api.internal.eventaudit
Interface EventAuditManagerInterface


public interface EventAuditManagerInterface

Interface that has to be implemented for each persistent layer that is supposed to be used.

Version:
1.0

Method Summary
 void configure(CallbackUtilities cus)
          Method configure is called at Shark start up, to configure implementation of EventAuditManagerInterface.
 void delete(WMSessionHandle shandle, AssignmentEventAuditPersistenceObject assea)
          Method delete
 void delete(WMSessionHandle shandle, CreateProcessEventAuditPersistenceObject cpea)
          Method delete
 void delete(WMSessionHandle shandle, DataEventAuditPersistenceObject dea)
          Method delete
 void delete(WMSessionHandle shandle, StateEventAuditPersistenceObject sea)
          Method delete
 java.util.List listActivityHistoryInfoWhere(WMSessionHandle shandle, java.lang.String sqlWhere, int startAt, int limit, boolean fillVariablesInfo)
           
 java.util.List listProcessDefinitionHistoryInfoWhere(WMSessionHandle shandle, java.lang.String factoryName, boolean countProcessInstances)
           
 java.util.List listProcessHistoryInfoWhere(WMSessionHandle shandle, java.lang.String sqlWhere, int startAt, int limit, boolean fillActivitiesInfo, boolean fillActivitiyVariablesInfo, boolean fillVariablesInfo)
           
 void persist(WMSessionHandle shandle, AssignmentEventAuditPersistenceObject assea)
          Method persist stores the assignment event into repository (usually database).
 void persist(WMSessionHandle shandle, CreateProcessEventAuditPersistenceObject cpea)
          Method persist stores the create process event into repository (usually database).
 void persist(WMSessionHandle shandle, DataEventAuditPersistenceObject dea)
          Method persist stores the data event into repository (usually database).
 void persist(WMSessionHandle shandle, StateEventAuditPersistenceObject sea)
          Method persist stores the state event into repository (usually database).
 boolean restore(WMSessionHandle shandle, AssignmentEventAuditPersistenceObject assea)
          Method restore retrieves assignment event from the repository.
 boolean restore(WMSessionHandle shandle, CreateProcessEventAuditPersistenceObject cpea)
          Method restore retrieves create process event from the repository.
 boolean restore(WMSessionHandle shandle, DataEventAuditPersistenceObject dea)
          Method restore retrieves data event from the repository.
 boolean restore(WMSessionHandle shandle, StateEventAuditPersistenceObject sea)
          Method restore retrieves state event from the repository.
 java.util.List restoreActivityHistory(WMSessionHandle shandle, java.lang.String procId, java.lang.String actId)
          Method restoreActivityHistory
 java.util.List restoreProcessHistory(WMSessionHandle shandle, java.lang.String procId)
          Method restoreProcessHistory
 

Method Detail

configure

void configure(CallbackUtilities cus)
               throws java.lang.Exception
Method configure is called at Shark start up, to configure implementation of EventAuditManagerInterface.

Parameters:
cus - an instance of CallbackUtilities used to get properties for configuring Event Audit Manager in Shark.
Throws:
java.lang.Exception - Thrown if configuring doesn't succeed.

persist

void persist(WMSessionHandle shandle,
             AssignmentEventAuditPersistenceObject assea)
             throws EventAuditException
Method persist stores the assignment event into repository (usually database).

Parameters:
assea - AssignmentEventAuditPersistenceInterface
Throws:
EventAuditException - on error.

persist

void persist(WMSessionHandle shandle,
             CreateProcessEventAuditPersistenceObject cpea)
             throws EventAuditException
Method persist stores the create process event into repository (usually database).

Parameters:
cpea - CreateProcessEventAuditPersistenceInterface
Throws:
EventAuditException - on error.

persist

void persist(WMSessionHandle shandle,
             DataEventAuditPersistenceObject dea)
             throws EventAuditException
Method persist stores the data event into repository (usually database).

Parameters:
dea - DataEventAuditPersistenceInterface
Throws:
EventAuditException - on error.

persist

void persist(WMSessionHandle shandle,
             StateEventAuditPersistenceObject sea)
             throws EventAuditException
Method persist stores the state event into repository (usually database).

Parameters:
sea - StateEventAuditPersistenceInterface
Throws:
EventAuditException - on error.

restore

boolean restore(WMSessionHandle shandle,
                AssignmentEventAuditPersistenceObject assea)
                throws EventAuditException
Method restore retrieves assignment event from the repository.

Parameters:
assea - AssignmentEventAuditPersistenceInterface
Returns:
true on success, false otherwise
Throws:
EventAuditException - on error.

restore

boolean restore(WMSessionHandle shandle,
                CreateProcessEventAuditPersistenceObject cpea)
                throws EventAuditException
Method restore retrieves create process event from the repository.

Parameters:
cpea - CreateProcessEventAuditPersistenceInterface
Returns:
true on success, false otherwise
Throws:
EventAuditException - on error.

restore

boolean restore(WMSessionHandle shandle,
                DataEventAuditPersistenceObject dea)
                throws EventAuditException
Method restore retrieves data event from the repository.

Parameters:
dea - DataEventAuditPersistenceInterface
Returns:
true on success, false otherwise
Throws:
EventAuditException - on error.

restore

boolean restore(WMSessionHandle shandle,
                StateEventAuditPersistenceObject sea)
                throws EventAuditException
Method restore retrieves state event from the repository.

Parameters:
sea - StateEventAuditPersistenceInterface
Returns:
true on success, false otherwise
Throws:
EventAuditException - on error.

restoreProcessHistory

java.util.List restoreProcessHistory(WMSessionHandle shandle,
                                     java.lang.String procId)
                                     throws EventAuditException
Method restoreProcessHistory

Parameters:
procId - a String
Returns:
a List
Throws:
EventAuditException - on error.

restoreActivityHistory

java.util.List restoreActivityHistory(WMSessionHandle shandle,
                                      java.lang.String procId,
                                      java.lang.String actId)
                                      throws EventAuditException
Method restoreActivityHistory

Parameters:
procId - a String
actId - a String
Returns:
a List
Throws:
EventAuditException - on error.

delete

void delete(WMSessionHandle shandle,
            AssignmentEventAuditPersistenceObject assea)
            throws EventAuditException
Method delete

Parameters:
assea - an AssignmentEventAuditPersistenceInterface
Throws:
EventAuditException - on error.

delete

void delete(WMSessionHandle shandle,
            CreateProcessEventAuditPersistenceObject cpea)
            throws EventAuditException
Method delete

Parameters:
cpea - a CreateProcessEventAuditPersistenceInterface
Throws:
EventAuditException - on error.

delete

void delete(WMSessionHandle shandle,
            DataEventAuditPersistenceObject dea)
            throws EventAuditException
Method delete

Parameters:
dea - a DataEventAuditPersistenceInterface
Throws:
EventAuditException - on error.

delete

void delete(WMSessionHandle shandle,
            StateEventAuditPersistenceObject sea)
            throws EventAuditException
Method delete

Parameters:
sea - a StateEventAuditPersistenceInterface
Throws:
EventAuditException - on error.

listProcessHistoryInfoWhere

java.util.List listProcessHistoryInfoWhere(WMSessionHandle shandle,
                                           java.lang.String sqlWhere,
                                           int startAt,
                                           int limit,
                                           boolean fillActivitiesInfo,
                                           boolean fillActivitiyVariablesInfo,
                                           boolean fillVariablesInfo)
                                           throws EventAuditException
Parameters:
shandle -
filter -
limit -
startAt -
Returns:
Throws:
EventAuditException

listActivityHistoryInfoWhere

java.util.List listActivityHistoryInfoWhere(WMSessionHandle shandle,
                                            java.lang.String sqlWhere,
                                            int startAt,
                                            int limit,
                                            boolean fillVariablesInfo)
                                            throws EventAuditException
Parameters:
shandle -
sqlWhere -
startAt -
limit -
Returns:
Throws:
EventAuditException

listProcessDefinitionHistoryInfoWhere

java.util.List listProcessDefinitionHistoryInfoWhere(WMSessionHandle shandle,
                                                     java.lang.String factoryName,
                                                     boolean countProcessInstances)
                                                     throws EventAuditException
Parameters:
shandle -
factoryName -
countProcessInstances -
Returns:
Throws:
EventAuditException