org.wfmc.audit
Class WMAAuditEntry

java.lang.Object
  org.wfmc.audit.WMAAuditEntry

All Implemented Interfaces:

CWADPrefix, java.io.Serializable

Direct Known Subclasses:

WMAAuditBase, WMARemoteAuditBase

public abstract class WMAAuditEntry

extends java.lang.Object

implements CWADPrefix

Author:

Antony Lodge, Adrian Price

See Also:

Serialized Form

Field Summary

static java.lang.String

WFMC

Constructor Summary

protected	WMAAuditEntry()
protected	WMAAuditEntry(CWADPrefix p) Constructor that takes a CWADPrefix object.
protected	WMAAuditEntry(java.lang.String processDefinitionId, java.lang.String activityDefinitionId, java.lang.String initialProcessInstanceId, java.lang.String currentProcessInstanceId, java.lang.String activityInstanceId, java.lang.String workItemId, int processState, WMAEventCode eventCode, java.lang.String domainId, java.lang.String nodeId, java.lang.String userId, java.lang.String roleId, java.util.Date timestamp) Constructor that takes all the CWADPrefix fields.

Method Summary

java.lang.String	formatCwadPrefix()
java.lang.String	getActivityDefinitionId() Returns the ID of the activity definition associated with the audit entry.
java.lang.String	getActivityInstanceId() Returns the activity instance Id.
java.lang.String	getCurrentProcessInstanceId() Returns the current process instance Id.
CWADPrefix	getCwadPrefix()
java.lang.String	getDomainId()
WMAEventCode	getEventCode() Returns the event code.
java.lang.String	getInformationId()
java.lang.String	getInitialProcessInstanceId() Returns the initial (root) process instance Id.
java.lang.String	getNodeId()
java.lang.String	getProcessDefinitionId() Returns the ID of the process definition associated with the audit entry.
java.lang.String	getProcessState() Returns the process state.
java.lang.String	getRoleId()
java.util.Date	getTimestamp()
java.lang.String	getUserId()
java.lang.String	getWorkItemId() Returns the work item Id.
void	setActivityDefinitionId(java.lang.String activityDefinitionId)
void	setActivityInstanceId(java.lang.String activityInstanceId) Set the activity instance Id.
void	setCurrentProcessInstanceId(java.lang.String currentProcessInstanceId) Set the current process instance Id.
void	setCwadPrefix(CWADPrefix p)
void	setDomainId(java.lang.String domainId)
void	setEventCode(WMAEventCode eventCode) Set the event code.
void	setInformationId(java.lang.String informationId)
void	setInitialProcessInstanceId(java.lang.String initialProcessInstanceId) Set the initial (root) process instance Id.
void	setNodeId(java.lang.String nodeId)
void	setProcessDefinitionId(java.lang.String processDefinitionId)
void	setProcessState(java.lang.String processState) Set the process state.
void	setRoleId(java.lang.String roleId)
void	setTimestamp(java.util.Date timestamp)
void	setUserId(java.lang.String userId)
void	setWorkItemId(java.lang.String workItemId) Set the work item Id.
protected static java.lang.String	valueOf(int state)
protected static int	valueOf(java.lang.String state)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WFMC

public static final java.lang.String WFMC

See Also:

Constant Field Values

Constructor Detail

WMAAuditEntry

protected WMAAuditEntry()

WMAAuditEntry

protected WMAAuditEntry(CWADPrefix p)

Constructor that takes a CWADPrefix object.

Parameters:

p - The prefix.

WMAAuditEntry

protected WMAAuditEntry(java.lang.String processDefinitionId,
                        java.lang.String activityDefinitionId,
                        java.lang.String initialProcessInstanceId,
                        java.lang.String currentProcessInstanceId,
                        java.lang.String activityInstanceId,
                        java.lang.String workItemId,
                        int processState,
                        WMAEventCode eventCode,
                        java.lang.String domainId,
                        java.lang.String nodeId,
                        java.lang.String userId,
                        java.lang.String roleId,
                        java.util.Date timestamp)

Constructor that takes all the CWADPrefix fields.

Parameters:

processDefinitionId -

activityDefinitionId -

initialProcessInstanceId -

currentProcessInstanceId -

activityInstanceId -

workItemId -

processState -

eventCode -

domainId -

nodeId -

userId -

roleId -

timestamp -

Method Detail

valueOf

protected static java.lang.String valueOf(int state)

valueOf

protected static int valueOf(java.lang.String state)

getCwadPrefix

public final CWADPrefix getCwadPrefix()

setCwadPrefix

public final void setCwadPrefix(CWADPrefix p)

getProcessDefinitionId

public java.lang.String getProcessDefinitionId()

Description copied from interface: CWADPrefix

Returns the ID of the process definition associated with the audit entry.

N.B. This property is an OBE extension to the WfMC standard, and is present to support audit queries that retrieve all changes pertaining to a particular process definition or its instances.

Specified by:

getProcessDefinitionId in interface CWADPrefix

setProcessDefinitionId

public void setProcessDefinitionId(java.lang.String processDefinitionId)

getActivityDefinitionId

public java.lang.String getActivityDefinitionId()

Description copied from interface: CWADPrefix

Returns the ID of the activity definition associated with the audit entry.

N.B. This property is an OBE extension to the WfMC standard, and is present to support audit queries that retrieve all changes pertaining to instances of a particular activity definition.

Specified by:

getActivityDefinitionId in interface CWADPrefix

setActivityDefinitionId

public void setActivityDefinitionId(java.lang.String activityDefinitionId)

getInitialProcessInstanceId

public java.lang.String getInitialProcessInstanceId()

Returns the initial (root) process instance Id.

Specified by:

getInitialProcessInstanceId in interface CWADPrefix

Returns:

The initial process instance Id

setInitialProcessInstanceId

public void setInitialProcessInstanceId(java.lang.String initialProcessInstanceId)

Set the initial (root) process instance Id.

Parameters:

initialProcessInstanceId - The initial process instance Id

getCurrentProcessInstanceId

public java.lang.String getCurrentProcessInstanceId()

Returns the current process instance Id.

Specified by:

getCurrentProcessInstanceId in interface CWADPrefix

Returns:

The current process instance Id

setCurrentProcessInstanceId

public void setCurrentProcessInstanceId(java.lang.String currentProcessInstanceId)

Set the current process instance Id. The string is limited to 64 characters according to the WfMC Interface 5 specification.

Parameters:

currentProcessInstanceId - The current process instance Id

getActivityInstanceId

public java.lang.String getActivityInstanceId()

Returns the activity instance Id. The activity instance Id is optional so this method may return null.

Specified by:

getActivityInstanceId in interface CWADPrefix

Returns:

The activity instance Id

setActivityInstanceId

public void setActivityInstanceId(java.lang.String activityInstanceId)

Set the activity instance Id. The value can be null if the activity instance Id is not specified.

Parameters:

activityInstanceId - The activity instance Id

getWorkItemId

public java.lang.String getWorkItemId()

Returns the work item Id. The work item Id is optional so this method may return null.

Specified by:

getWorkItemId in interface CWADPrefix

Returns:

The work item Id.

setWorkItemId

public void setWorkItemId(java.lang.String workItemId)

Set the work item Id.

Parameters:

workItemId - Work item Id.

getProcessState

public java.lang.String getProcessState()

Returns the process state.

Specified by:

getProcessState in interface CWADPrefix

Returns:

The process state

setProcessState

public void setProcessState(java.lang.String processState)

Set the process state.

Parameters:

processState - The process state

getEventCode

public WMAEventCode getEventCode()

Returns the event code.

Specified by:

getEventCode in interface CWADPrefix

Returns:

The event code

setEventCode

public void setEventCode(WMAEventCode eventCode)

Set the event code.

Parameters:

eventCode - The new event code

getDomainId

public java.lang.String getDomainId()

Specified by:

getDomainId in interface CWADPrefix

setDomainId

public void setDomainId(java.lang.String domainId)

getNodeId

public java.lang.String getNodeId()

Specified by:

getNodeId in interface CWADPrefix

setNodeId

public void setNodeId(java.lang.String nodeId)

getUserId

public java.lang.String getUserId()

Specified by:

getUserId in interface CWADPrefix

setUserId

public void setUserId(java.lang.String userId)

getRoleId

public java.lang.String getRoleId()

Specified by:

getRoleId in interface CWADPrefix

setRoleId

public void setRoleId(java.lang.String roleId)

getTimestamp

public java.util.Date getTimestamp()

Specified by:

getTimestamp in interface CWADPrefix

setTimestamp

public void setTimestamp(java.util.Date timestamp)

getInformationId

public final java.lang.String getInformationId()

Specified by:

getInformationId in interface CWADPrefix

setInformationId

public final void setInformationId(java.lang.String informationId)

formatCwadPrefix

public java.lang.String formatCwadPrefix()