oracle.bpm.services.instancequery
Interface IAuditVariable

All Superinterfaces:

java.io.Serializable

public interface IAuditVariable
extends java.io.Serializable

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	isAttribute() Returns the type of the variable as a flag.
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

isIndicator

boolean isIndicator()

Returns true if the variable being represented is a Business Indicator.

Returns:

setName

void setName(java.lang.String name)

Sets the identifying name for the variable. (Internal use only).

Parameters:

name -

getName

java.lang.String getName()

Returns the identifying name for the variable

Returns:

The String name of the variable.

setDataType

void setDataType(java.lang.String dataType)

Sets the data type of the variable value. This is specified as one of a simple set of NUMBER, DATE or TEXT. (Internal use only).

Parameters:

dataType - String data type

getDataType

java.lang.String getDataType()

Returns the String data type for the variable value.

Returns:

The String name of the variable value data type.

setModelDataType

void setModelDataType(java.lang.String modelDataType)

Sets the model data type of the variable value. This is specified as data type as defined in the design time model. (Internal use only).

Parameters:

modelDataType -

getModelDataType

java.lang.String getModelDataType()

Returns the String model data type for the variable value.

Returns:

setValue

void setValue(java.lang.Object value)

Sets the value of the variable. (Internal use only).

Parameters:

value - - The Object variable value

getValue

java.lang.Object getValue()

Returns the value of the variable as an Object.

Returns:

getPreviousValue

java.lang.Object getPreviousValue()

Returns the previous (old) value for a variable when the variable has been updated.

Returns:

setType

void setType(java.lang.String type)

Sets the type of the variable. The type denotes the purpose of the variable in terms of either

• D - Dimension
• M - Measure
• C - Counter

(Internal use only).

Parameters:

type - String type code.

getType

java.lang.String getType()

Returns the type of the variable. The type denotes the purpose of the variable in terms of either

• D - Dimension
• M - Measure
• C - Counter

Returns:

The String type code.

setTable

void setTable(java.lang.String table)

(Internal use only).

Parameters:

table -

getTable

java.lang.String getTable()

setAttribute

void setAttribute(int attribute)

(Internal use only).

Parameters:

attribute -

getAttribute

int getAttribute()

Returns the slot number where the variable can be found in the base table.

Returns:

The int index number as to where the variable is persisted.

isDimension

boolean isDimension()

Returns the type of the variable as a flag. This is a utility method over the Type.

Returns:

True if the variable is a Dimension

isMeasure

boolean isMeasure()

Returns the type of the variable as a flag. This is a utility method over the Type.

Returns:

True if the variable is a Measure

isCounter

boolean isCounter()

Returns the type of the variable as a flag. This is a utility method over the Type.

Returns:

True if the variable is a Counter

isAttribute

boolean isAttribute()

Returns the type of the variable as a flag. This is a utility method over the Type.

Returns:

True if the variable is an Attribute

hasRange

boolean hasRange()

Indicates if there is a range specified in the meta data for this variable.

Returns:

True if the variable has a range specified.

getRangeValue

java.lang.String getRangeValue()

Returns the String range value as specified in the variable metadata. The value returned will be the range value that the actual variable value maps to.

Returns:

The String range value for the variable value.

setRanges

void setRanges(java.util.List<oracle.bpm.services.instancequery.IAuditVariableRange> ranges)

Sets the list of valid ranges for this variable. (Internal use only).

Parameters:

ranges -

setDirection

void setDirection(IAuditVariable.Direction direction)

The direction documents the position that the variable should take in the audit log payload. This is based on one of three positions to document whether it is an input variable, an output variable or simply provided on the payload to display its state.

• STATE
• INPUT
• OUTPUT

(Internal use only).

Parameters:

direction -

getDirection

IAuditVariable.Direction getDirection()

The direction documents the position that the variable should take in the audit log payload. This is based on one of three positions to document whether it is an input variable, an output variable or simply provided on the payload to display its state.

• STATE
• INPUT
• OUTPUT

Returns: