Package com.webmethods.portal.service.task

Interface ITaskProcessAuditService

All Superinterfaces:

IComponent, IInitializable, ITaskComponent

public interface ITaskProcessAuditService
extends ITaskComponent

Service that handles auditing of task operations into shared ProcessAudit. The information about the task will be used in the monitor

Field Summary

Fields

Modifier and Type	Field	Description
static final int	STATUS_ACCEPTED	Task is active and was accepted by the user
static final int	STATUS_CANCELLED	Task was cancelled
static final int	STATUS_COMPLETED	Task has completed
static final int	STATUS_ENDED	Step successfully completed
static final int	STATUS_EXPIRED	Task expired
static final int	STATUS_FAILED	Task failed
static final int	STATUS_QUEUED	Tasks is active in the queue
static final int	STATUS_RESUMED	Task was suspended
static final int	STATUS_STARTED	Step was started
static final int	STATUS_SUSPENDED	Task was suspended
static final int	STATUS_UNDEFINED	Step status is undefined (for newly added steps)
static final int	TASK_ENGINE_SYSTEM	Identifier for TaskEngine used for auditing task engine events

Method Summary

Modifier and Type	Method	Description
String	getProcessAuditPoolName()	Returns datasource name for ProcessAudit pool
void	initProcessAuditPool()	Attempts to initialize ProcessAudit pool
boolean	isProcessArchived(String processID)	Checks process audit database if specified process audit is archived
boolean	isProcessAuditPoolInitialized()	Indicates if ProcessAudit schema pool is initialized
void	logTaskAudit(IURI principalURI, ITask task, int status)	Logs task audit event

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Field Details

TASK_ENGINE_SYSTEM

static final int TASK_ENGINE_SYSTEM

Identifier for TaskEngine used for auditing task engine events

See Also:

• Constant Field Values

STATUS_UNDEFINED

static final int STATUS_UNDEFINED

Step status is undefined (for newly added steps)

See Also:

• Constant Field Values

STATUS_STARTED

static final int STATUS_STARTED

Step was started

See Also:

• Constant Field Values

STATUS_ENDED

static final int STATUS_ENDED

Step successfully completed

See Also:

• Constant Field Values

STATUS_QUEUED

static final int STATUS_QUEUED

Tasks is active in the queue

See Also:

• Constant Field Values

STATUS_ACCEPTED

static final int STATUS_ACCEPTED

Task is active and was accepted by the user

See Also:

• Constant Field Values

STATUS_COMPLETED

static final int STATUS_COMPLETED

Task has completed

See Also:

• Constant Field Values

STATUS_SUSPENDED

static final int STATUS_SUSPENDED

Task was suspended

See Also:

• Constant Field Values

STATUS_RESUMED

static final int STATUS_RESUMED

Task was suspended

See Also:

• Constant Field Values

STATUS_CANCELLED

static final int STATUS_CANCELLED

Task was cancelled

See Also:

• Constant Field Values

STATUS_FAILED

static final int STATUS_FAILED

Task failed

See Also:

• Constant Field Values

STATUS_EXPIRED

static final int STATUS_EXPIRED

Task expired

See Also:

• Constant Field Values

Method Details

initProcessAuditPool

void initProcessAuditPool()
                   throws PortalException

Attempts to initialize ProcessAudit pool

Throws:

PortalException

isProcessAuditPoolInitialized

boolean isProcessAuditPoolInitialized()

Indicates if ProcessAudit schema pool is initialized

Returns:

getProcessAuditPoolName

String getProcessAuditPoolName()

Returns datasource name for ProcessAudit pool

logTaskAudit

void logTaskAudit(IURI principalURI,
 ITask task,
 int status)
           throws PortalException

Logs task audit event

Parameters:

principalURI - pricipal performed task operation

task - task instance to log audit on

status - audit status

Throws:

PortalException

isProcessArchived

boolean isProcessArchived(String processID)
                   throws PortalException

Checks process audit database if specified process audit is archived

Parameters:

processID -

Throws:

PortalException