com.ragic.s3.service.workflow
Interface ScriptParameter

All Known Implementing Classes:

ScriptPostflowParameter, ScriptPreflowParameter

public interface ScriptParameter

ScriptParameter is an interface which describes a default variable in pre/post-workflow, param.

User: liberation
Date: 2010/10/5
Time: 11:07:06 am

Method Summary

int	getNewNodeId(int domainId) Returns the node ID of given field after new value being written.
java.util.List<java.lang.Integer>	getNewNodeIds(int domainId) Similar to getNewNodeId, but can access multiple IDs at the same time, which is useful when dealing with multiple-selection fields.
java.lang.String	getNewValue(int domainId) Returns the value of given field after new value being written. Returned value should be the same value as getOldNodeId if no change submitted.
java.util.List<java.lang.String>	getNewValues(int domainId) Similar to getNewValue, but can access multiple values at the same time, which is useful when dealing with multiple-selection fields.
int	getOldNodeId(int domainId) Returns the node ID of given field before new value being written.
java.util.List<java.lang.Integer>	getOldNodeIds(int domainId) Similar to getOldNodeId, but can access multiple IDs at the same time, which is useful when dealing with multiple-selection fields.
java.lang.String	getOldValue(int domainId) Returns the value of given field before new value being written.
java.util.List<java.lang.String>	getOldValues(int domainId) Similar to getOldValue, but can access multiple values at the same time, which is useful when dealing with multiple-selection fields.
java.lang.String	getOperationType(int domainId)
java.util.List<ScriptParameter>	getSubtableEntry(int domainId) Returns a list of ScriptParameters which can manipulated each record in the subtale. With toArray() every item in list can be called by each index, which is recommended.

Method Detail

getNewNodeId

int getNewNodeId(int domainId)

Returns the node ID of given field after new value being written. Returned value will be the same value as getOldNodeId if no change submitted.

Parameters:

domainId - field ID of interest

Returns:

node ID after new value being written

getOldNodeId

int getOldNodeId(int domainId)

Returns the node ID of given field before new value being written. Usually used for selection or multiple selection, because each choice in a selection list is a single node.

Parameters:

domainId - field ID of interest

Returns:

node ID before new value being written

getNewNodeIds

java.util.List<java.lang.Integer> getNewNodeIds(int domainId)

Similar to getNewNodeId, but can access multiple IDs at the same time, which is useful when dealing with multiple-selection fields.

Parameters:

domainId - field ID of interest

Returns:

a list of field IDs after new data being written into database.

See Also:

getNewNodeId(int)

getOldNodeIds

java.util.List<java.lang.Integer> getOldNodeIds(int domainId)

Similar to getOldNodeId, but can access multiple IDs at the same time, which is useful when dealing with multiple-selection fields.

Parameters:

domainId - field ID of interest

Returns:

a list of node IDs before new data being written into database.

See Also:

getOldNodeId(int)

getNewValue

java.lang.String getNewValue(int domainId)

Returns the value of given field after new value being written.
Returned value should be the same value as getOldNodeId if no change submitted. Also, null value can occur if the field is left blank.

Parameters:

domainId - field ID of interest

Returns:

field value after new value being written

getOldValue

java.lang.String getOldValue(int domainId)

Returns the value of given field before new value being written. Returned value should be the same value as getNewNodeId if no change submitted. Also, null value can occur if the field is left blank.

Parameters:

domainId - field ID of interest

Returns:

field value before new value being written

getNewValues

java.util.List<java.lang.String> getNewValues(int domainId)

Similar to getNewValue, but can access multiple values at the same time, which is useful when dealing with multiple-selection fields.

Parameters:

domainId - field ID of interest

Returns:

a list of field values after new data being written into database.

See Also:

getNewValue(int)

getOldValues

java.util.List<java.lang.String> getOldValues(int domainId)

Similar to getOldValue, but can access multiple values at the same time, which is useful when dealing with multiple-selection fields.

Parameters:

domainId - field ID of interest

Returns:

a list of field values before new data being written into database.

See Also:

getOldValue(int)

getOperationType

java.lang.String getOperationType(int domainId)

Parameters:

domainId -

Returns:

"I", if data of this field are just created.
"M", if the data of this field are created before and are just revised.

getSubtableEntry

java.util.List<ScriptParameter> getSubtableEntry(int domainId)

Returns a list of ScriptParameters which can manipulated each record in the subtale.
With toArray() every item in list can be called by each index, which is recommended.

Parameters:

domainId - the root field ID of the subtable

Returns:

a list of ScriptParameter which can be used to manipulate each record in subtable