Package com.orchestranetworks.addon.dpra.function.execution.result

Class ValueSequence

java.lang.Object

com.orchestranetworks.addon.dpra.function.execution.result.ValueSequence

public final class ValueSequence
extends java.lang.Object

Defines a set of OutputDefinition values when executing a function.

Since:

4.2.0

See Also:

FunctionResult.addSequence(ValueSequence)

Method Summary

Modifier and Type	Method	Description
java.util.List<FunctionValue>	getValues()	Returns the list values in the sequence.
ValueSequence	linkWithRecords(com.onwbp.adaptation.XPathFilter xpathFilter)	Sets the filter for linked records for execution at the table and field levels.
ValueSequence	linkWithRecords(java.lang.String xpathFilter)	Sets the filter for linked records for execution at the table and field levels.
ValueSequence	set(java.lang.String outputName, boolean value)	Sets the value for a boolean output in the sequence.
ValueSequence	set(java.lang.String outputName, java.lang.Integer value)	Sets the value for an integer output in the sequence.
ValueSequence	set(java.lang.String outputName, java.lang.String value)	Sets the value for a string output in the sequence.
ValueSequence	set(java.lang.String outputName, java.math.BigDecimal value)	Sets the value for a decimal output in the sequence.
ValueSequence	set(java.lang.String outputName, java.util.Date value)	Sets the value for a date time output in the sequence.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

set

public ValueSequence set(java.lang.String outputName,
                         boolean value)

Sets the value for a boolean output in the sequence.

Parameters:

outputName - The name of the output.

value - The specific value.

Throws:

java.lang.IllegalArgumentException - If the output name is invalid.

See Also:

OutputDefinition.forBoolean(String, UserMessage, UserMessage)

set

public ValueSequence set(java.lang.String outputName,
                         java.math.BigDecimal value)

Sets the value for a decimal output in the sequence.

Parameters:

outputName - The name of the output.

value - The specific value.

Throws:

java.lang.IllegalArgumentException - If the output name is invalid.

See Also:

OutputDefinition.forDecimal(String, UserMessage, UserMessage)

set

public ValueSequence set(java.lang.String outputName,
                         java.util.Date value)

Sets the value for a date time output in the sequence.

Parameters:

outputName - The name of the output.

value - The specific value.

Throws:

java.lang.IllegalArgumentException - If the output name is invalid.

See Also:

OutputDefinition.forDateTime(String, UserMessage, UserMessage)

set

public ValueSequence set(java.lang.String outputName,
                         java.lang.Integer value)

Sets the value for an integer output in the sequence.

Parameters:

outputName - The name of the output.

value - The specific value.

Throws:

java.lang.IllegalArgumentException - If the output name is invalid.

See Also:

OutputDefinition.forInteger(String, UserMessage, UserMessage)

set

public ValueSequence set(java.lang.String outputName,
                         java.lang.String value)

Sets the value for a string output in the sequence.

Parameters:

outputName - The name of the output.

value - The specific value.

Throws:

java.lang.IllegalArgumentException - If the output name is invalid.

See Also:

OutputDefinition.forString(String, UserMessage, UserMessage)

getValues

public java.util.List<FunctionValue> getValues()

Returns the list values in the sequence.

linkWithRecords

public ValueSequence linkWithRecords(java.lang.String xpathFilter)

Sets the filter for linked records for execution at the table and field levels.

Parameters:

xpathFilter - XPath predicate used to look up linked records.

Throws:

java.lang.IllegalStateException - If linked records are not enabled.

See Also:

ExecutionContextOnTable.isLinkedRecordEnabled(), XPathFilter.validateForTableNode(SchemaNode)

linkWithRecords

public ValueSequence linkWithRecords(com.onwbp.adaptation.XPathFilter xpathFilter)

Sets the filter for linked records for execution at the table and field levels.

Parameters:

xpathFilter - XPath predicate used to look up linked records.

Throws:

java.lang.IllegalStateException - If linked records are not enabled.

See Also:

ExecutionContextOnTable.isLinkedRecordEnabled(), XPathFilter.validateForTableNode(SchemaNode)