|
Oracle Fusion Middleware Java API Reference for Oracle BPM Suite 11g Release 1 (11.1.1.6.3) E25378-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IAuditVariable
An object that represents an audit variable. An audit variable can represent a process or project data object that will be reported in the audit detail (payload). Primarily, the IAuditVariable will represent a business indicator complete with the addition metadata that defines some important aspects of the variable to the client application.
Nested Class Summary | |
---|---|
static class |
IAuditVariable.Direction Innerclass to provide the enum tp define what section the variable should appear on within the audit event payload. |
Method Summary | |
---|---|
int |
getAttribute() Returns the slot number where the variable can be found in the base table. |
java.lang.String |
getDataType() Returns the String data type for the variable value. |
IAuditVariable.Direction |
getDirection() The direction documents the position that the variable should take in the audit log payload. |
java.lang.String |
getModelDataType() Returns the String model data type for the variable value. |
java.lang.String |
getName() Returns the identifying name for the variable |
java.lang.Object |
getPreviousValue() Returns the previous (old) value for a variable when the variable has been updated. |
java.lang.String |
getRangeValue() Returns the String range value as specified in the variable metadata. |
java.lang.String |
getTable() |
java.lang.String |
getType() Returns the type of the variable. |
java.lang.Object |
getValue() Returns the value of the variable as an Object. |
boolean |
hasRange() Indicates if there is a range specified in the meta data for this variable. |
boolean |
isCounter() Returns the type of the variable as a flag. |
boolean |
isDimension() Returns the type of the variable as a flag. |
boolean |
isIndicator() Returns true if the variable being represented is a Business Indicator. |
boolean |
isMeasure() Returns the type of the variable as a flag. |
void |
setAttribute(int attribute) (Internal use only). |
void |
setDataType(java.lang.String dataType) Sets the data type of the variable value. |
void |
setDirection(IAuditVariable.Direction direction) The direction documents the position that the variable should take in the audit log payload. |
void |
setModelDataType(java.lang.String modelDataType) Sets the model data type of the variable value. |
void |
setName(java.lang.String name) Sets the identifying name for the variable. |
void |
setRanges(java.util.List<oracle.bpm.services.instancequery.IAuditVariableRange> ranges) Sets the list of valid ranges for this variable. |
void |
setTable(java.lang.String table) (Internal use only). |
void |
setType(java.lang.String type) Sets the type of the variable. |
void |
setValue(java.lang.Object value) Sets the value of the variable. |
Method Detail |
---|
boolean isIndicator()
true
if the variable being represented is a Business Indicator.void setName(java.lang.String name)
name
-java.lang.String getName()
void setDataType(java.lang.String dataType)
dataType
- String
data typejava.lang.String getDataType()
String
data type for the variable value.String
name of the variable value data type.void setModelDataType(java.lang.String modelDataType)
modelDataType
-java.lang.String getModelDataType()
String
model data type for the variable value.void setValue(java.lang.Object value)
value
- - The Object
variable valuejava.lang.Object getValue()
java.lang.Object getPreviousValue()
void setType(java.lang.String type)
type
- String
type code.java.lang.String getType()
String
type code.void setTable(java.lang.String table)
table
-java.lang.String getTable()
void setAttribute(int attribute)
attribute
-int getAttribute()
int
index number as to where the variable is persisted.boolean isDimension()
boolean isMeasure()
boolean isCounter()
boolean hasRange()
java.lang.String getRangeValue()
String
range value as specified in the variable metadata. The value returned will be the range value that the actual variable value maps to.String
range value for the variable value.void setRanges(java.util.List<oracle.bpm.services.instancequery.IAuditVariableRange> ranges)
ranges
-void setDirection(IAuditVariable.Direction direction)
direction
-IAuditVariable.Direction getDirection()
|
Oracle Fusion Middleware Java API Reference for Oracle BPM Suite 11g Release 1 (11.1.1.6.3) E25378-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |