com.sssw.wf.client
Interface EbiAuditDelegate

All Superinterfaces:

EbiDelegate

public interface EbiAuditDelegate

extends EbiDelegate

Delegate interface for querying work queue audit data. This delegate returns a list with the state of workitem documents and properties at each activity step.

To get an instance of the audit delegate use EboFactory.getAuditDelegate().

Fields inherited from interface com.sssw.fw.api.EbiDelegate

SERVICE_LOCAL, SERVICE_REMOTE

Method Summary

org.w3c.dom.Document

getAuditInfo(String processId, String runNumber, String activityName, Date startDate, Date endDate) Gets audit information based on parameters set.

Methods implemented from interface com.sssw.fw.api.EbiDelegate

getName

Method Detail

getAuditInfo

public org.w3c.dom.Document getAuditInfo(String processId,
                                         String runNumber,
                                         String activityName,
                                         Date startDate,
                                         Date endDate)
                                  throws EboAuditLoggerException

Gets audit information based on parameters set. All method parameters are optional. Pass in "null" to override and get all information

Parameters:

processId - Process Id to filter on. Optional

runNumber - Run number to filter on. Optional

activityName - Activity name to filter on. Optional

startDate - Start date to filter by. Optional, but if used End date must also be provided.

endDate - End date to filter on. Option, but if used Start date must also be provided.

Returns:

Returns a document containing the audit information. Conforms to workflow-auditlist_3_0.dtd

Throws:

EboAuditLoggerException - Throws an EboAuditLoggerException if the information cannot be retrieved.