Skip navigation links

oracle.bpm.services.instancequery
Interface IAuditInstance

All Superinterfaces:

java.io.Serializable

public interface IAuditInstance

extends java.io.Serializable

An object that represents an instance of an audit message. Client code should not concern itself with the setters. They are used internally to create and configure the IAuditInstance.

Method Summary

void	addAssociatedVariable(java.lang.String name) Adds a variable name to a managed list to assert what variables are being referenced and should be reported on further.
void	addAuditPayloadElement(IAuditVariable element) (Internal use only).
java.lang.String	getActivityId() Returns the activity ID of the flow-element to which the IAuditInstance is reporting on.
java.lang.String	getActivityName() Returns the activity name of the flow-element to which the IAuditInstance is reporting on.
java.lang.String	getActivityType() Returns the type of activity.
java.util.Map<java.lang.String,IAuditVariable>	getAllVariables() Returns a List of business indicators, including their current value as a snapshot for this IAuditInstance.
java.lang.String	getAuditInstanceType() Returns the audit-instance type.
java.lang.Long	getAuditLevel() Retruns the loggin level that the audit record was created at.
byte[]	getAuditLog() Returns the compressed audit detail XML.
java.lang.String	getComment() Gets the user comment for the audit record.
java.lang.String	getComponentInstanceId() Returns the instance ID of the component.
java.lang.String	getComponentName() Returns the name of the component.
java.lang.String	getComponentType() Returns the type of the component from where the audit message was generated.
java.lang.String	getCompositeDn() Returns the composite-DN
java.lang.String	getCompositeInstanceId() Returns the instance ID of the composite.
java.lang.String	getCompositeName() Returns the name of the composite.
java.util.Calendar	getCreateTime() Returns the time-stamp at which the audit record was created.
java.util.Calendar	getDateValue(int slot) Returns the value of the date business indicator stored at a particular slot.
java.util.List<java.util.Calendar>	getDateValues() Returns all date business indicator values as a List of values.
java.lang.String	getDN() Returns the domain name part from the Composite Domain Name.
java.lang.String	getDNApplicationName() Returns the application name part from the Composite Domain Name (CompositeDN).
java.lang.String	getDNCompositeName() Returns the composite name part from the Composite Domain Name (compositeDN).
java.lang.String	getDNLabel() Returns the label part from the Composite Domain Name.
java.lang.String	getDNRevision() Returns the revision part from the composite domain name.
java.util.Calendar	getDueDate() Returns the work item expiration date as a due date.
java.lang.String	getECID() Returns the ECID for the audit record.
boolean	getFaultIsrecoverable() Returns true if the fault reported in the audit record is recoverable.
java.lang.String	getFaultType() Returns the fault type message should one be reported in the audit record.
java.lang.String	getFlowElementType() Returns the name of the flow-element type.
java.lang.Long	getInstanceCount() Returns the multi-instance count for a multi=instance characteristic.
java.lang.String	getInvokedComponentName()
java.lang.String	getLabel() Returns the label name for the flow-element.
java.lang.Long	getLoopCount() Returns the loop count for a looping or multi-instance characteristic.
java.math.BigDecimal	getNumberValue(int slot) Returns the value of the numeric business indciator stored at a particular slot.
java.util.List<java.math.BigDecimal>	getNumberValues() Returns all numeric business indicator values as a List of values.
AuditInstanceOperation	getOperation() Returns the operation value of the aidut record.
java.lang.Long	getParentThreadId() Returns the ID of the parent thread.
java.lang.String	getParticipant() Returns the last known participant of a Human Task.
java.util.Calendar	getPartitionDate() Returns the partition date.
org.w3c.dom.Document	getPayloadDoc()
java.util.Map<java.lang.String,IAuditVariable>	getPayloadElements()
java.lang.Long	getPriority()
java.util.Calendar	getProcessDueDate()
java.lang.String	getProcessName() Returns the name of the process
java.lang.Long	getQueryId() Returns the Query ID of the audit record
java.lang.String	getReferenceId() Returns the referenced activity ID.
java.lang.String	getRoleId() Returns the last known participant role of a Human Task.
java.lang.String	getScopeId() Returns the execution scope ID for the flow-element reported in the audit record.
java.lang.String	getSourceActivity() Returns the activity ID of hte preceding flow-element.
java.lang.Long	getStep() Returns the step number as processed by the engine.
java.lang.String	getStringValue(int slot) Returns the value of the string business indicator stored at a particular slot.
java.util.List<java.lang.String>	getStringValues() Returs all string business indicator values as a List of values.
java.lang.String	getTargetActivity() Returns the activity ID of the subsequent flow-element
java.lang.Long	getThreadId() Returns the ID of the current thread.
java.lang.String	getTitle() Returns the name of the flow-element.
java.lang.Long	getUserTaskNumber() Returns the Human Workflow Task number.
IAuditVariable	getVariable(java.lang.String name) Adds a business variable definition and value to the AuditEvent structure.
java.util.Map<java.lang.String,IAuditVariable>	getVariables() Returns a List of business indicators, including their current value as a snapshot for this IAuditInstance.
boolean	hasPayload() A helper method to assert if the audit record contains audit detail information (payload).
boolean	isMinimalInfoAvailable() (Internal use only).
void	recordDataChange(java.lang.String name, java.lang.Object oldValue, java.lang.Object newValue) Records a data change to a data object or business indicator.
void	setActivityId(java.lang.String activityId) Sets the flow-element activity ID to which the IAuditInstance is reporting on (Internal use only).
void	setActivityName(java.lang.String activityName) Sets the flow-element activity name to which the IAuditInstance is reporting on.
void	setActivityType(java.lang.String string) Sets the type of activity.
void	setAssociatedVariables(java.util.List<java.lang.String> associatedVariables) Sets the associated variables as a list of variable names.
void	setAuditInstanceType(java.lang.String auditInstanceType) Sets the type of audit-instance type.
void	setAuditLevel(java.lang.Long auditLevel) Sets the level at which the audit record was logged.
void	setAuditLog(byte[] auditLog) Sets the compressed audit detail XML.
void	setComment(java.lang.String comment) Sets a user comment for the audit record.
void	setComponentInstanceId(java.lang.String componenetInstanceId) Sets the instance ID of the component.
void	setComponentName(java.lang.String componentName) Sets the name of the component.
void	setComponentType(java.lang.String componentType) Sets the type of the component from where the audit message was generated.
void	setCompositeDn(java.lang.String compositeDn) Sets the composite-DN.
void	setCompositeInstanceId(java.lang.String compositeInstanceId) Sets the instance ID of the composite (Internal use only).
void	setCompositeName(java.lang.String compositeName) Sets the name of the composite.
void	setCreateTime(java.util.Calendar createTime) Sets the time-stamp at which the audit record was created.
void	setDateValue(int slot, java.util.Calendar value) Sets the date value of a business indicator located at a particular slot.
void	setDateValues(java.util.List<java.util.Calendar> values) Sets the date business indicator values as populated from a List of values.
void	setDueDate(java.util.Calendar dueDate) Sets the work item expiration date (Internal use only).
void	setECID(java.lang.String ecid) Retruns the ECID for the audit record.
void	setFaultIsrecoverable(boolean isFailutRecoverable) Sets the falg true if the fault reported in the audit record is recoverable.
void	setFaultType(java.lang.String faultType) Sets the message for hte type of fault should one be reported in the audit record.
void	setFlowElementType(java.lang.String flowElementType) Sets the flow-element type.
void	setInstanceCount(java.lang.Long multiInstanceCount) Sets the instance count for a multi-instance characteristic.
void	setInvokedComponentName(java.lang.String invokedComponentName) (Internal use only).
void	setLabel(java.lang.String label) Sets the default label name of the flow-element.
void	setLoopCount(java.lang.Long value) Sets the loop count for a looping or multi-instance characteristic.
void	setNumberValue(int slot, java.math.BigDecimal value) Sets the numeric value of a business indicator located at a particular slot.
void	setNumberValues(java.util.List<java.math.BigDecimal> values) Sets the numeric business indicator values as populated from a list of values.
void	setOperation(AuditInstanceOperation operation) Sets the operation name for the audit record.
void	setParentThreadId(java.lang.Long parentThreadId) Sets the ID of the parent thread.
void	setParticipant(java.lang.String participant) Sets the last known participant of a Human Task.
void	setPartitionDate(java.util.Calendar ciPartitionDate) Sets the partition date.
void	setPriority(java.lang.Long priority) (Internal use only).
void	setProcessDueDate(java.util.Calendar processDueDate) (Internal use only).
void	setProcessName(java.lang.String processName) Sets the name of the process.
void	setQueryId(java.lang.Long queryId) Sets teh query ID.
void	setReferenceId(java.lang.String referenceId) Sets the activity ID of the flow-element that is related to the flow- element reported in the audit record.
void	setRoleId(java.lang.String roleId) Sets the last known participant role of a Human Task.
void	setScopeId(java.lang.String scopeId) Sets the execution scope ID for the flow-element reported in the audit record.
void	setSourceActivity(java.lang.String sourceActivity) Sets the activity ID of the preceding flow-element.
void	setStep(java.lang.Long step) Sets the step number as processed by the engine.
void	setStringValue(int slot, java.lang.String value) Sets the string value of a business indicator located at a particular slot.
void	setStringValues(java.util.List<java.lang.String> values) Sets the string business indicator values as populated from a list of values.
void	setTargetActivity(java.lang.String targetActivity) Sets the activity ID for the subsequent flow-element.
void	setThreadId(java.lang.Long threadId) Sets the ID of the current thread.
void	setTitle(java.lang.String title) Sets the name of the flow-element.
void	setUserTaskNumber(java.lang.Long userTaskNumber) Sets the Human Workflow Task number.

Method Detail

isMinimalInfoAvailable

boolean isMinimalInfoAvailable()

(Internal use only).

Returns:

getVariable

IAuditVariable getVariable(java.lang.String name)

Adds a business variable definition and value to the AuditEvent structure. During persistence, this variable will be de-normalized to the appropriate AuditQueryAttribute or AuditQuery Attribute extension table.

Parameters:

name - AuditEventAttribute containing the variable value and definition.

Returns:

IAuditVariable for the given variable.

getVariables

java.util.Map<java.lang.String,IAuditVariable> getVariables()

Returns a List of business indicators, including their current value as a snapshot for this IAuditInstance. When the IAuditInstance referrs to a artifact node, i.e. a measurement mark, the list of business indicators will be limited in scope to those business indicators that are directly referenced in the definition of the artifact flow-element.

Returns:

a List of business indicators, including their current value.

getAllVariables

java.util.Map<java.lang.String,IAuditVariable> getAllVariables()

Returns a List of business indicators, including their current value as a snapshot for this IAuditInstance. The returned list of business indicators is not limited in scope and will contain all business indicators for the project.

Returns:

a List of business indicators, including their current value.

setActivityId

void setActivityId(java.lang.String activityId)

Sets the flow-element activity ID to which the IAuditInstance is reporting on (Internal use only).

Parameters:

activityId - - The activity ID

getActivityId

java.lang.String getActivityId()

Returns the activity ID of the flow-element to which the IAuditInstance is reporting on.

Returns:

The activity ID

setActivityName

void setActivityName(java.lang.String activityName)

Sets the flow-element activity name to which the IAuditInstance is reporting on. (Internal use only).

Parameters:

activityName - - The activity name

getActivityName

java.lang.String getActivityName()

Returns the activity name of the flow-element to which the IAuditInstance is reporting on.

Returns:

The activity name

setAuditInstanceType

void setAuditInstanceType(java.lang.String auditInstanceType)

Sets the type of audit-instance type. The audit-instance type denotes if the audit message is a pre-audit (START), post-audit (END) or an intermediate type (INTERMEDIATE) audit record. (Internal use only).

Parameters:

auditInstanceType - - The type description of the audit instance.

getAuditInstanceType

java.lang.String getAuditInstanceType()

Returns the audit-instance type. The audit-instance type denotes if the audit message is a pre-audit (START), post-audit (END) or an intermediate type (INTERMEDIATE) audit record.

Returns:

The audit-instance type

setComponentInstanceId

void setComponentInstanceId(java.lang.String componenetInstanceId)

Sets the instance ID of the component. (Internal use only).

Parameters:

componenetInstanceId - - the instance ID of the component

getComponentInstanceId

java.lang.String getComponentInstanceId()

Returns the instance ID of the component.

Returns:

the instance ID of the component

setComponentName

void setComponentName(java.lang.String componentName)

Sets the name of the component. (Internal use only).

Parameters:

componentName - - The name of the component

getComponentName

java.lang.String getComponentName()

Returns the name of the component.

Returns:

The name of the component

setComponentType

void setComponentType(java.lang.String componentType)

Sets the type of the component from where the audit message was generated. (Internal use only).

Parameters:

componentType - - The component-type

getComponentType

java.lang.String getComponentType()

Returns the type of the component from where the audit message was generated. For BPM, this is invariably "BPMN.

Returns:

The component-type.

setCompositeDn

void setCompositeDn(java.lang.String compositeDn)

Sets the composite-DN. (Internal use only).

Parameters:

compositeDn - - The composite-DN

getCompositeDn

java.lang.String getCompositeDn()

Returns the composite-DN

Returns:

The composite-DN

setCompositeInstanceId

void setCompositeInstanceId(java.lang.String compositeInstanceId)

Sets the instance ID of the composite (Internal use only).

Parameters:

compositeInstanceId - - The instance ID of the composite

getCompositeInstanceId

java.lang.String getCompositeInstanceId()

Returns the instance ID of the composite.

Returns:

The instance ID of the composite.

setCompositeName

void setCompositeName(java.lang.String compositeName)

Sets the name of the composite. (Internal use only).

Parameters:

compositeName - - The name of the composite

getCompositeName

java.lang.String getCompositeName()

Returns the name of the composite.

Returns:

The name of the composite

setProcessName

void setProcessName(java.lang.String processName)

Sets the name of the process. (Internal use only).

Parameters:

processName - - The name of the process

getProcessName

java.lang.String getProcessName()

Returns the name of the process

Returns:

The name of the process

setStep

void setStep(java.lang.Long step)

Sets the step number as processed by the engine. (Internal use only).

Parameters:

step - - The step number

getStep

java.lang.Long getStep()

Returns the step number as processed by the engine. This will only report on the current step for the audit record and is not associated with the activity or flow node to which the audit record belongs.

Returns:

The step number

setLoopCount

void setLoopCount(java.lang.Long value)

Sets the loop count for a looping or multi-instance characteristic. (Internal use only).

Parameters:

value - - Loop count value

getLoopCount

java.lang.Long getLoopCount()

Returns the loop count for a looping or multi-instance characteristic. The value returned will either be the loop count for looping or the instance count for the multi-instance characteristic.

Returns:

loop count or instance count value.

setCreateTime

void setCreateTime(java.util.Calendar createTime)

Sets the time-stamp at which the audit record was created.

Parameters:

createTime - - The time-stamp at which time the audit record was created. (Internal use only).

getCreateTime

java.util.Calendar getCreateTime()

Returns the time-stamp at which the audit record was created.

Returns:

The time-stamp at which the audit record was created.

setDueDate

void setDueDate(java.util.Calendar dueDate)

Sets the work item expiration date (Internal use only).

Parameters:

dueDate - - The work item due by date

getDueDate

java.util.Calendar getDueDate()

Returns the work item expiration date as a due date.

Returns:

workitem expiration date

setFaultIsrecoverable

void setFaultIsrecoverable(boolean isFailutRecoverable)

Sets the falg true if the fault reported in the audit record is recoverable. (Internal use only).

Parameters:

isFailutRecoverable - - true if the fault is recoverable

getFaultIsrecoverable

boolean getFaultIsrecoverable()

Returns true if the fault reported in the audit record is recoverable.

Returns:

Whether the reported fault is recoverable

setFaultType

void setFaultType(java.lang.String faultType)

Sets the message for hte type of fault should one be reported in the audit record. (Internal use only).

Parameters:

faultType - - fault type message

getFaultType

java.lang.String getFaultType()

Returns the fault type message should one be reported in the audit record.

Returns:

fault type message

setFlowElementType

void setFlowElementType(java.lang.String flowElementType)

Sets the flow-element type. (Internal use only).

Parameters:

flowElementType - - Name of the flow-element type

getFlowElementType

java.lang.String getFlowElementType()

Returns the name of the flow-element type.

Returns:

name of the flow-element type

setInvokedComponentName

void setInvokedComponentName(java.lang.String invokedComponentName)

(Internal use only).

Parameters:

invokedComponentName -

getInvokedComponentName

java.lang.String getInvokedComponentName()

setLabel

void setLabel(java.lang.String label)

Sets the default label name of the flow-element. This value is not localized

Parameters:

label - - The label for the flow-element name

getLabel

java.lang.String getLabel()

Returns the label name for the flow-element. This value is not localized.

Returns:

flow-element label name.

setOperation

void setOperation(AuditInstanceOperation operation)

Sets the operation name for the audit record. (Internal use only).

Parameters:

operation - - AuditInstanceOperation

See Also:

AuditInstanceOperation

getOperation

AuditInstanceOperation getOperation()

Returns the operation value of the aidut record.

Returns:

Audit Operation

See Also:

AuditInstanceOperation

setParentThreadId

void setParentThreadId(java.lang.Long parentThreadId)

Sets the ID of the parent thread. A thread is the ID of the sequence flow that the process will traversed. A parent thread is the sequence flow that was traversed before some type of gateway action. Each branch of a gateway will be identified by its own thread ID. The parent thread is the sequence flow from which the branch occurs. (Internal use only).

Parameters:

parentThreadId - - The ID of the parent thread.

getParentThreadId

java.lang.Long getParentThreadId()

Returns the ID of the parent thread. A thread is the ID of the sequence flow that the process will traversed. A parent thread is the sequence flow that was traversed before some type of gateway action. Each branch of a gateway will be identified by its own thread ID. The parentthread is the sequence flow from which the branch occurs.

Returns:

parent thread ID

setParticipant

void setParticipant(java.lang.String participant)

Sets the last known participant of a Human Task. (Internal use only).

Parameters:

participant - - Human Task participant

getParticipant

java.lang.String getParticipant()

Returns the last known participant of a Human Task.

Returns:

Human Task participant

setUserTaskNumber

void setUserTaskNumber(java.lang.Long userTaskNumber)

Sets the Human Workflow Task number. This provides a means to reconcile the BPMN Human Task to the Human Workflow via the task number. (Internal use only).

Parameters:

userTaskNumber - - Task number

getUserTaskNumber

java.lang.Long getUserTaskNumber()

Returns the Human Workflow Task number. This provides a means to reconcile the BPMN Human Task to the Human Workflow Task via the task number.

Returns:

Taks number

getPartitionDate

java.util.Calendar getPartitionDate()

Returns the partition date. This date reconciles the process instance creation across all components of a composite to facilitate information purging.

Returns:

partition date

setPartitionDate

void setPartitionDate(java.util.Calendar ciPartitionDate)

Sets the partition date. This date reconciles the process instance creation across all components of a composite to facilitate information purging. (Internal use only).

Parameters:

ciPartitionDate - - partition date

getPriority

java.lang.Long getPriority()

setPriority

void setPriority(java.lang.Long priority)

(Internal use only).

Parameters:

priority -

setProcessDueDate

void setProcessDueDate(java.util.Calendar processDueDate)

(Internal use only).

Parameters:

processDueDate -

getProcessDueDate

java.util.Calendar getProcessDueDate()

getQueryId

java.lang.Long getQueryId()

Returns the Query ID of the audit record

Returns:

The query ID

setReferenceId

void setReferenceId(java.lang.String referenceId)

Sets the activity ID of the flow-element that is related to the flow- element reported in the audit record. (Internal use only).

Parameters:

referenceId - - The reference activity ID

getReferenceId

java.lang.String getReferenceId()

Returns the referenced activity ID. For instance, a STOP Measurement Mark, the reference ID will to the associated START mesurement mark.

Returns:

referenced flow-element activiyt ID

setRoleId

void setRoleId(java.lang.String roleId)

Sets the last known participant role of a Human Task. (Internal use only).

Parameters:

roleId - - Human Task participant role

getRoleId

java.lang.String getRoleId()

Returns the last known participant role of a Human Task.

Returns:

Human Task participant role

setSourceActivity

void setSourceActivity(java.lang.String sourceActivity)

Sets the activity ID of the preceding flow-element.

Parameters:

sourceActivity - - The preceding activity ID

getSourceActivity

java.lang.String getSourceActivity()

Returns the activity ID of hte preceding flow-element.

Returns:

The preceding activity ID

setTargetActivity

void setTargetActivity(java.lang.String targetActivity)

Sets the activity ID for the subsequent flow-element. (Internal use only).

Parameters:

targetActivity - - Subsequent activity ID

getTargetActivity

java.lang.String getTargetActivity()

Returns the activity ID of the subsequent flow-element

Returns:

The subsequent activity ID

setThreadId

void setThreadId(java.lang.Long threadId)

Sets the ID of the current thread. A thread is the ID of the sequence flow that the process will traversed. Each branch of a gateway will be identified by its own thread ID. The parent thread is the sequence flow from which the branch occurs. (Internal use only).

Parameters:

threadId -

getThreadId

java.lang.Long getThreadId()

Returns the ID of the current thread. A thread is the ID of the sequence flow that the process will traversed. Each branch of a gateway will be identified by its own thread ID. The parentthread is the sequence flow from which the branch occurs.

Returns:

Current thread ID

setTitle

void setTitle(java.lang.String title)

Sets the name of the flow-element. (Internal use only).

Parameters:

title - - flow-element name

getTitle

java.lang.String getTitle()

Returns the name of the flow-element.

Returns:

The flow-element name

addAuditPayloadElement

void addAuditPayloadElement(IAuditVariable element)

(Internal use only).

Parameters:

element -

getPayloadElements

java.util.Map<java.lang.String,IAuditVariable> getPayloadElements()

setAuditLevel

void setAuditLevel(java.lang.Long auditLevel)

Sets the level at which the audit record was logged. This is controlled through the Config MBeans. There are basically three levels of logging. <hd>Level</hd><hd>Description</hd>

OFF	No logging will occur
MINIMAL	Audit records will be created with no detail
PRODUCTION	Audit records will be created. Detail will only be provided for service type activities
DEVELOPMENT	Audit records will be created with full detail

(Internal use only).

Parameters:

auditLevel - The audit logging level

getAuditLevel

java.lang.Long getAuditLevel()

Retruns the loggin level that the audit record was created at.

Returns:

The audit logging level

setAuditLog

void setAuditLog(byte[] auditLog)

Sets the compressed audit detail XML. (Internal use only).

Parameters:

auditLog - - Compressed audit detail

getAuditLog

byte[] getAuditLog()

Returns the compressed audit detail XML.

Returns:

compressed audit detail XML.

getDNApplicationName

java.lang.String getDNApplicationName()

Returns the application name part from the Composite Domain Name (CompositeDN).

Returns:

The application name

getDNCompositeName

java.lang.String getDNCompositeName()

Returns the composite name part from the Composite Domain Name (compositeDN).

Returns:

The compoiste name

getDN

java.lang.String getDN()

Returns the domain name part from the Composite Domain Name.

Returns:

domain name

getDNLabel

java.lang.String getDNLabel()

Returns the label part from the Composite Domain Name.

Returns:

domain name label

getDNRevision

java.lang.String getDNRevision()

Returns the revision part from the composite domain name.

Returns:

revision

getDateValue

java.util.Calendar getDateValue(int slot)

Returns the value of the date business indicator stored at a particular slot. A slot is in index number within the audit instance structure that points to a business object metadata and value.

Parameters:

slot - - Business indicator slot number

Returns:

Date business indicator value

setDateValue

void setDateValue(int slot,
                  java.util.Calendar value)

Sets the date value of a business indicator located at a particular slot. A slot is in index number within the audit instance structure that points to a business object metadata and value. (Internal use only).

Parameters:

slot - - Business indicator slot number

value - - value for the date business indicator

getNumberValue

java.math.BigDecimal getNumberValue(int slot)

Returns the value of the numeric business indciator stored at a particular slot. A slot is in index number within the audit instance structure that points to a business object metadata and value. (Internal use only).

Parameters:

slot - - Business indicator slot number

Returns:

setNumberValue

void setNumberValue(int slot,
                    java.math.BigDecimal value)

Sets the numeric value of a business indicator located at a particular slot. A slot is in index number within the audit instance structure that points to a business object metadata and value.

Parameters:

slot - - Business indicator slot number

value - - value for the numeric business indicator

getStringValue

java.lang.String getStringValue(int slot)

Returns the value of the string business indicator stored at a particular slot. A slot is in index number within the audit instance structure that points to a business object metadata and value.

Parameters:

slot - - Business indicator slot number

Returns:

setStringValue

void setStringValue(int slot,
                    java.lang.String value)

Sets the string value of a business indicator located at a particular slot. A slot is in index number within the audit instance structure that points to a business object metadata and value. (Internal use only).

Parameters:

slot - - Business indicator slot number

value - - value for the string business indicator

setDateValues

void setDateValues(java.util.List<java.util.Calendar> values)

Sets the date business indicator values as populated from a List of values. (Internal use only).

Parameters:

values - - value List

setNumberValues

void setNumberValues(java.util.List<java.math.BigDecimal> values)

Sets the numeric business indicator values as populated from a list of values. (Internal use only).

Parameters:

values - - value List

setStringValues

void setStringValues(java.util.List<java.lang.String> values)

Sets the string business indicator values as populated from a list of values. (Internal use only).

Parameters:

values - - value List

getDateValues

java.util.List<java.util.Calendar> getDateValues()

Returns all date business indicator values as a List of values.

Returns:

List of values

getNumberValues

java.util.List<java.math.BigDecimal> getNumberValues()

Returns all numeric business indicator values as a List of values.

Returns:

List of values

getStringValues

java.util.List<java.lang.String> getStringValues()

Returs all string business indicator values as a List of values.

Returns:

List of values

hasPayload

boolean hasPayload()

A helper method to assert if the audit record contains audit detail information (payload).

Returns:

True if the audit record contains detail information.

addAssociatedVariable

void addAssociatedVariable(java.lang.String name)

Adds a variable name to a managed list to assert what variables are being referenced and should be reported on further.

Parameters:

name - - Name of the variable that is being referenced

getActivityType

java.lang.String getActivityType()

Returns the type of activity. This identifies the type of flow-element.

Returns:

setActivityType

void setActivityType(java.lang.String string)

Sets the type of activity. This identifies the type of flow-element. (Internal use only).

Parameters:

string -

setAssociatedVariables

void setAssociatedVariables(java.util.List<java.lang.String> associatedVariables)

Sets the associated variables as a list of variable names. The list of variable names asserts what variables are being referenced and should be reported on further. (Internal use only).

Parameters:

associatedVariables - - List of variable names

setInstanceCount

void setInstanceCount(java.lang.Long multiInstanceCount)

Sets the instance count for a multi-instance characteristic. The setLoopCount can be used in place of this method. (Internal use only).

Parameters:

multiInstanceCount - - The instance count

getInstanceCount

java.lang.Long getInstanceCount()

Returns the multi-instance count for a multi=instance characteristic. The getLoopCount method can be used in place of this method.

Returns:

setScopeId

void setScopeId(java.lang.String scopeId)

Sets the execution scope ID for the flow-element reported in the audit record. (Internal use only).

Parameters:

scopeId - - Execution scope ID

getScopeId

java.lang.String getScopeId()

Returns the execution scope ID for the flow-element reported in the audit record.

Returns:

The execution scope ID

setQueryId

void setQueryId(java.lang.Long queryId)

Sets teh query ID. (Internal use only).

Parameters:

queryId - - query ID

getComment

java.lang.String getComment()

Gets the user comment for the audit record.

Returns:

User comment

setComment

void setComment(java.lang.String comment)

Sets a user comment for the audit record. (Internal use only).

Parameters:

comment - - user comment

getPayloadDoc

org.w3c.dom.Document getPayloadDoc()

recordDataChange

void recordDataChange(java.lang.String name,
                      java.lang.Object oldValue,
                      java.lang.Object newValue)
                      throws BPMException

Records a data change to a data object or business indicator. The data change is recorded as a part of the audit instance payload. This method is used in conjuction with the audit log API and is not part of the internal engine runtime auditing mechanism.

Parameters:

name -

oldValue -

newValue -

Throws:

BPMException

getECID

java.lang.String getECID()

Returns the ECID for the audit record.

Returns:

ecid

setECID

void setECID(java.lang.String ecid)

Retruns the ECID for the audit record. (Internal use only).

Parameters:

ecid -

Skip navigation links