com.hcl.domino.data

Interface Formula

public interface Formula

A compiled Domino formula that can be evaluated standalone or on one or multiple documents.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Formula.FormulaExecutionResult Formula computation result

Method Summary

Modifier and Type	Method and Description
List<Object>	evaluate() Evaluates the formula in the current environment (client/server)
List<Object>	evaluate(Document doc) Runs a formula on a document
Double	evaluateAsNumber(Document doc, Double defaultValue) Runs a formula on a document and converts the result to a number
Double	evaluateAsNumber(Double defaultValue) Evaluates the formula and converts the result to a number
String	evaluateAsString() Evaluates the formula and converts the result to a string
String	evaluateAsString(Document doc) Runs a formula on a document and converts the result to a string
Formula.FormulaExecutionResult	evaluateExt(Document doc) Formula execution that returns more information about the computation result
String	getFormula() Returns the formula string that was used to compile this Formula object

Method Detail

getFormula

String getFormula()

Returns the formula string that was used to compile this Formula object

Returns:

formula string

evaluate

List<Object> evaluate()

Evaluates the formula in the current environment (client/server)

Returns:

the return values of the formula as a List

evaluateAsString

String evaluateAsString()

Evaluates the formula and converts the result to a string

Returns:

result

evaluateAsNumber

Double evaluateAsNumber(Double defaultValue)

Evaluates the formula and converts the result to a number

Parameters:

defaultValue - default value to be returned of result is not a number

Returns:

result

evaluate

List<Object> evaluate(Document doc)

Runs a formula on a document

Parameters:

doc - the document context

Returns:

result, e.g. List with String or DominoDateTime

evaluateAsString

String evaluateAsString(Document doc)

Runs a formula on a document and converts the result to a string

Parameters:

doc - document

Returns:

result

evaluateAsNumber

Double evaluateAsNumber(Document doc,
                        Double defaultValue)

Runs a formula on a document and converts the result to a number

Parameters:

doc - document

defaultValue - default value to be returned of result is not a number

Returns:

result

evaluateExt

Formula.FormulaExecutionResult evaluateExt(Document doc)

Formula execution that returns more information about the computation result

Parameters:

doc - document

Returns:

result