|
Oracle Fusion Middleware Java API Reference for Oracle BPM Suite 11g Release 1 (11.1.1.6.0) E25378-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IAuditInstance
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 |
---|
boolean isMinimalInfoAvailable()
IAuditVariable getVariable(java.lang.String name)
name
- AuditEventAttribute
containing the variable value and definition.java.util.Map<java.lang.String,IAuditVariable> getVariables()
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.List
of business indicators, including their current value.java.util.Map<java.lang.String,IAuditVariable> getAllVariables()
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.List
of business indicators, including their current value.void setActivityId(java.lang.String activityId)
IAuditInstance
is reporting on (Internal use only).activityId
- - The activity IDjava.lang.String getActivityId()
IAuditInstance
is reporting on.void setActivityName(java.lang.String activityName)
IAuditInstance
is reporting on. (Internal use only).activityName
- - The activity namejava.lang.String getActivityName()
IAuditInstance
is reporting on.void setAuditInstanceType(java.lang.String auditInstanceType)
auditInstanceType
- - The type description of the audit instance.java.lang.String getAuditInstanceType()
void setComponentInstanceId(java.lang.String componenetInstanceId)
componenetInstanceId
- - the instance ID of the componentjava.lang.String getComponentInstanceId()
void setComponentName(java.lang.String componentName)
componentName
- - The name of the componentjava.lang.String getComponentName()
void setComponentType(java.lang.String componentType)
componentType
- - The component-typejava.lang.String getComponentType()
void setCompositeDn(java.lang.String compositeDn)
compositeDn
- - The composite-DNjava.lang.String getCompositeDn()
void setCompositeInstanceId(java.lang.String compositeInstanceId)
compositeInstanceId
- - The instance ID of the compositejava.lang.String getCompositeInstanceId()
void setCompositeName(java.lang.String compositeName)
compositeName
- - The name of the compositejava.lang.String getCompositeName()
void setProcessName(java.lang.String processName)
processName
- - The name of the processjava.lang.String getProcessName()
void setStep(java.lang.Long step)
step
- - The step numberjava.lang.Long getStep()
void setLoopCount(java.lang.Long value)
value
- - Loop count valuejava.lang.Long getLoopCount()
void setCreateTime(java.util.Calendar createTime)
createTime
- - The time-stamp at which time the audit record was created. (Internal use only).java.util.Calendar getCreateTime()
void setDueDate(java.util.Calendar dueDate)
dueDate
- - The work item due by datejava.util.Calendar getDueDate()
void setFaultIsrecoverable(boolean isFailutRecoverable)
isFailutRecoverable
- - true if the fault is recoverableboolean getFaultIsrecoverable()
void setFaultType(java.lang.String faultType)
faultType
- - fault type messagejava.lang.String getFaultType()
void setFlowElementType(java.lang.String flowElementType)
flowElementType
- - Name of the flow-element typejava.lang.String getFlowElementType()
void setInvokedComponentName(java.lang.String invokedComponentName)
invokedComponentName
-java.lang.String getInvokedComponentName()
void setLabel(java.lang.String label)
label
- - The label for the flow-element namejava.lang.String getLabel()
void setOperation(AuditInstanceOperation operation)
operation
- - AuditInstanceOperationAuditInstanceOperation
AuditInstanceOperation getOperation()
AuditInstanceOperation
void setParentThreadId(java.lang.Long parentThreadId)
parentThreadId
- - The ID of the parent thread.java.lang.Long getParentThreadId()
void setParticipant(java.lang.String participant)
participant
- - Human Task participantjava.lang.String getParticipant()
void setUserTaskNumber(java.lang.Long userTaskNumber)
userTaskNumber
- - Task numberjava.lang.Long getUserTaskNumber()
java.util.Calendar getPartitionDate()
void setPartitionDate(java.util.Calendar ciPartitionDate)
ciPartitionDate
- - partition datejava.lang.Long getPriority()
void setPriority(java.lang.Long priority)
priority
-void setProcessDueDate(java.util.Calendar processDueDate)
processDueDate
-java.util.Calendar getProcessDueDate()
java.lang.Long getQueryId()
void setReferenceId(java.lang.String referenceId)
referenceId
- - The reference activity IDjava.lang.String getReferenceId()
void setRoleId(java.lang.String roleId)
roleId
- - Human Task participant rolejava.lang.String getRoleId()
void setSourceActivity(java.lang.String sourceActivity)
sourceActivity
- - The preceding activity IDjava.lang.String getSourceActivity()
void setTargetActivity(java.lang.String targetActivity)
targetActivity
- - Subsequent activity IDjava.lang.String getTargetActivity()
void setThreadId(java.lang.Long threadId)
threadId
-java.lang.Long getThreadId()
void setTitle(java.lang.String title)
title
- - flow-element namejava.lang.String getTitle()
void addAuditPayloadElement(IAuditVariable element)
element
-java.util.Map<java.lang.String,IAuditVariable> getPayloadElements()
void setAuditLevel(java.lang.Long auditLevel)
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 |
auditLevel
- The audit logging leveljava.lang.Long getAuditLevel()
void setAuditLog(byte[] auditLog)
auditLog
- - Compressed audit detailbyte[] getAuditLog()
java.lang.String getDNApplicationName()
java.lang.String getDNCompositeName()
java.lang.String getDN()
java.lang.String getDNLabel()
java.lang.String getDNRevision()
java.util.Calendar getDateValue(int slot)
slot
- - Business indicator slot numbervoid setDateValue(int slot, java.util.Calendar value)
slot
- - Business indicator slot numbervalue
- - value for the date business indicatorjava.math.BigDecimal getNumberValue(int slot)
slot
- - Business indicator slot numbervoid setNumberValue(int slot, java.math.BigDecimal value)
slot
- - Business indicator slot numbervalue
- - value for the numeric business indicatorjava.lang.String getStringValue(int slot)
slot
- - Business indicator slot numbervoid setStringValue(int slot, java.lang.String value)
slot
- - Business indicator slot numbervalue
- - value for the string business indicatorvoid setDateValues(java.util.List<java.util.Calendar> values)
values
- - value Listvoid setNumberValues(java.util.List<java.math.BigDecimal> values)
values
- - value Listvoid setStringValues(java.util.List<java.lang.String> values)
values
- - value Listjava.util.List<java.util.Calendar> getDateValues()
java.util.List<java.math.BigDecimal> getNumberValues()
java.util.List<java.lang.String> getStringValues()
boolean hasPayload()
void addAssociatedVariable(java.lang.String name)
name
- - Name of the variable that is being referencedjava.lang.String getActivityType()
void setActivityType(java.lang.String string)
string
-void setAssociatedVariables(java.util.List<java.lang.String> associatedVariables)
associatedVariables
- - List of variable namesvoid setInstanceCount(java.lang.Long multiInstanceCount)
multiInstanceCount
- - The instance countjava.lang.Long getInstanceCount()
void setScopeId(java.lang.String scopeId)
scopeId
- - Execution scope IDjava.lang.String getScopeId()
void setQueryId(java.lang.Long queryId)
queryId
- - query IDjava.lang.String getComment()
void setComment(java.lang.String comment)
comment
- - user commentorg.w3c.dom.Document getPayloadDoc()
void recordDataChange(java.lang.String name, java.lang.Object oldValue, java.lang.Object newValue) throws BPMException
name
-oldValue
-newValue
-BPMException
java.lang.String getECID()
void setECID(java.lang.String ecid)
ecid
-
|
Oracle Fusion Middleware Java API Reference for Oracle BPM Suite 11g Release 1 (11.1.1.6.0) E25378-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |