org.apache.manifoldcf.scriptengine

Interface Variable

All Known Implementing Classes:

VariableArray, VariableBase, VariableBoolean, VariableConfiguration, VariableConfigurationNode, VariableConnectionName, VariableDict, VariableFloat, VariableInt, VariableQueryArg, VariableResult, VariableString, VariableURL

public interface Variable

This interface represents a variable within the ManifoldCF script engine. A variable may have a value, and may have various named properties, as described below.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_BOOLEAN Conversion to boolean
static java.lang.String	ATTRIBUTE_CREATEDSTATUS CREATED status attribute
static java.lang.String	ATTRIBUTE_DICT Dict attribute
static java.lang.String	ATTRIBUTE_FLOAT Conversion to float
static java.lang.String	ATTRIBUTE_INT Conversion to int
static java.lang.String	ATTRIBUTE_NOTFOUNDSTATUS NOTFOUND status attribute
static java.lang.String	ATTRIBUTE_OKSTATUS OK status attribute
static java.lang.String	ATTRIBUTE_SCRIPT Script value
static java.lang.String	ATTRIBUTE_SIZE Size attribute
static java.lang.String	ATTRIBUTE_STRING Conversion to string
static java.lang.String	ATTRIBUTE_TYPE Name attribute
static java.lang.String	ATTRIBUTE_UNAUTHORIZEDSTATUS UNAUTHORIZED status attribute
static java.lang.String	ATTRIBUTE_VALUE Value attribute

Method Summary

Modifier and Type	Method and Description
VariableReference	ampersand(Variable v)
VariableReference	asterisk(Variable v)
VariableReference	doubleAmpersand(Variable v)
VariableReference	doubleEquals(Variable v)
VariableReference	doublePipe(Variable v)
VariableReference	exclamationEquals(Variable v)
VariableReference	getAttribute(java.lang.String attributeName) Get a named attribute of the variable; e.g.
boolean	getBooleanValue() Get the variable's value as a boolean
ConfigurationNode	getConfigurationNodeValue() Get the variable's value as a ConfigurationNode object
Configuration	getConfigurationValue() Get the variable's value as a Configuration object
double	getDoubleValue() Get the variable's value as a double
VariableReference	getIndexed(Variable index) Get an indexed property of the variable
int	getIntValue() Get the variable's value as an integer
java.lang.String	getQueryArgumentValue() Get the variable's value as a properly-encoded query argument
java.lang.String	getScriptValue() Get the variable's script value
java.lang.String	getStringValue() Get the variable's value as a string
java.lang.String	getURLPathValue() Get the variable's value as a URL path component
VariableReference	greaterAngle(Variable v)
VariableReference	greaterAngleEquals(Variable v)
boolean	hasBooleanValue() Check if the variable has a boolean value
boolean	hasConfigurationNodeValue() Check if the variable has a ConfigurationNode value
boolean	hasConfigurationValue() Check if the variable has a Configuration value
boolean	hasDoubleValue() Check if the variable has a double value
boolean	hasIntValue() Check if the variable has an int value
boolean	hasQueryArgumentValue() Check if the variable has a query argument value
boolean	hasScriptValue() Check if the variable has a script value
boolean	hasStringValue() Check if the variable has a string value
boolean	hasURLPathValue() Check if the variable has a URL path value
void	insertAt(Variable v, Variable index) Insert an object into this variable at a position.
VariableReference	lesserAngle(Variable v)
VariableReference	lesserAngleEquals(Variable v)
VariableReference	minus(Variable v)
VariableReference	pipe(Variable v)
VariableReference	plus(Variable v)
void	removeAt(Variable index) Delete an object from this variable at a position.
VariableReference	slash(Variable v)
VariableReference	unaryExclamation()
VariableReference	unaryMinus()

Field Detail

ATTRIBUTE_STRING

static final java.lang.String ATTRIBUTE_STRING

Conversion to string

See Also:

Constant Field Values

ATTRIBUTE_INT

static final java.lang.String ATTRIBUTE_INT

Conversion to int

See Also:

Constant Field Values

ATTRIBUTE_FLOAT

static final java.lang.String ATTRIBUTE_FLOAT

Conversion to float

See Also:

Constant Field Values

ATTRIBUTE_BOOLEAN

static final java.lang.String ATTRIBUTE_BOOLEAN

Conversion to boolean

See Also:

Constant Field Values

ATTRIBUTE_SCRIPT

static final java.lang.String ATTRIBUTE_SCRIPT

Script value

See Also:

Constant Field Values

ATTRIBUTE_TYPE

static final java.lang.String ATTRIBUTE_TYPE

Name attribute

See Also:

Constant Field Values

ATTRIBUTE_VALUE

static final java.lang.String ATTRIBUTE_VALUE

Value attribute

See Also:

Constant Field Values

ATTRIBUTE_SIZE

static final java.lang.String ATTRIBUTE_SIZE

Size attribute

See Also:

Constant Field Values

ATTRIBUTE_DICT

static final java.lang.String ATTRIBUTE_DICT

Dict attribute

See Also:

Constant Field Values

ATTRIBUTE_OKSTATUS

static final java.lang.String ATTRIBUTE_OKSTATUS

OK status attribute

See Also:

Constant Field Values

ATTRIBUTE_NOTFOUNDSTATUS

static final java.lang.String ATTRIBUTE_NOTFOUNDSTATUS

NOTFOUND status attribute

See Also:

Constant Field Values

ATTRIBUTE_CREATEDSTATUS

static final java.lang.String ATTRIBUTE_CREATEDSTATUS

CREATED status attribute

See Also:

Constant Field Values

ATTRIBUTE_UNAUTHORIZEDSTATUS

static final java.lang.String ATTRIBUTE_UNAUTHORIZEDSTATUS

UNAUTHORIZED status attribute

See Also:

Constant Field Values

Method Detail

hasStringValue

boolean hasStringValue()
                throws ScriptException

Check if the variable has a string value

Throws:

ScriptException

getStringValue

java.lang.String getStringValue()
                         throws ScriptException

Get the variable's value as a string

Throws:

ScriptException

hasScriptValue

boolean hasScriptValue()
                throws ScriptException

Check if the variable has a script value

Throws:

ScriptException

getScriptValue

java.lang.String getScriptValue()
                         throws ScriptException

Get the variable's script value

Throws:

ScriptException

hasConfigurationValue

boolean hasConfigurationValue()
                       throws ScriptException

Check if the variable has a Configuration value

Throws:

ScriptException

getConfigurationValue

Configuration getConfigurationValue()
                             throws ScriptException

Get the variable's value as a Configuration object

Throws:

ScriptException

hasConfigurationNodeValue

boolean hasConfigurationNodeValue()
                           throws ScriptException

Check if the variable has a ConfigurationNode value

Throws:

ScriptException

getConfigurationNodeValue

ConfigurationNode getConfigurationNodeValue()
                                     throws ScriptException

Get the variable's value as a ConfigurationNode object

Throws:

ScriptException

hasBooleanValue

boolean hasBooleanValue()
                 throws ScriptException

Check if the variable has a boolean value

Throws:

ScriptException

getBooleanValue

boolean getBooleanValue()
                 throws ScriptException

Get the variable's value as a boolean

Throws:

ScriptException

hasIntValue

boolean hasIntValue()
             throws ScriptException

Check if the variable has an int value

Throws:

ScriptException

getIntValue

int getIntValue()
         throws ScriptException

Get the variable's value as an integer

Throws:

ScriptException

hasDoubleValue

boolean hasDoubleValue()
                throws ScriptException

Check if the variable has a double value

Throws:

ScriptException

getDoubleValue

double getDoubleValue()
               throws ScriptException

Get the variable's value as a double

Throws:

ScriptException

hasQueryArgumentValue

boolean hasQueryArgumentValue()
                       throws ScriptException

Check if the variable has a query argument value

Throws:

ScriptException

getQueryArgumentValue

java.lang.String getQueryArgumentValue()
                                throws ScriptException

Get the variable's value as a properly-encoded query argument

Throws:

ScriptException

hasURLPathValue

boolean hasURLPathValue()
                 throws ScriptException

Check if the variable has a URL path value

Throws:

ScriptException

getURLPathValue

java.lang.String getURLPathValue()
                          throws ScriptException

Get the variable's value as a URL path component

Throws:

ScriptException

plus

VariableReference plus(Variable v)
                throws ScriptException

Throws:

ScriptException

minus

VariableReference minus(Variable v)
                 throws ScriptException

Throws:

ScriptException

asterisk

VariableReference asterisk(Variable v)
                    throws ScriptException

Throws:

ScriptException

slash

VariableReference slash(Variable v)
                 throws ScriptException

Throws:

ScriptException

unaryMinus

VariableReference unaryMinus()
                      throws ScriptException

Throws:

ScriptException

greaterAngle

VariableReference greaterAngle(Variable v)
                        throws ScriptException

Throws:

ScriptException

lesserAngle

VariableReference lesserAngle(Variable v)
                       throws ScriptException

Throws:

ScriptException

doubleEquals

VariableReference doubleEquals(Variable v)
                        throws ScriptException

Throws:

ScriptException

greaterAngleEquals

VariableReference greaterAngleEquals(Variable v)
                              throws ScriptException

Throws:

ScriptException

lesserAngleEquals

VariableReference lesserAngleEquals(Variable v)
                             throws ScriptException

Throws:

ScriptException

exclamationEquals

VariableReference exclamationEquals(Variable v)
                             throws ScriptException

Throws:

ScriptException

ampersand

VariableReference ampersand(Variable v)
                     throws ScriptException

Throws:

ScriptException

pipe

VariableReference pipe(Variable v)
                throws ScriptException

Throws:

ScriptException

doubleAmpersand

VariableReference doubleAmpersand(Variable v)
                           throws ScriptException

Throws:

ScriptException

doublePipe

VariableReference doublePipe(Variable v)
                      throws ScriptException

Throws:

ScriptException

unaryExclamation

VariableReference unaryExclamation()
                            throws ScriptException

Throws:

ScriptException

getAttribute

VariableReference getAttribute(java.lang.String attributeName)
                        throws ScriptException

Get a named attribute of the variable; e.g. xxx.yyy

Throws:

ScriptException

insertAt

void insertAt(Variable v,
              Variable index)
       throws ScriptException

Insert an object into this variable at a position. Use null to insert at end.

Throws:

ScriptException

removeAt

void removeAt(Variable index)
       throws ScriptException

Delete an object from this variable at a position.

Throws:

ScriptException

getIndexed

VariableReference getIndexed(Variable index)
                      throws ScriptException

Get an indexed property of the variable

Throws:

ScriptException