com.sonicsw.xq
Interface XQParameterInfo

All Superinterfaces:

java.lang.Cloneable, XQCloneable

public interface XQParameterInfo
extends XQCloneable

XQParameterInfo objects are individual parameters within an XQParameters instance. This object stores the internal representation of each of the parameters, including its name, type, value and reference. Instances of XQParameterInfo are created by calling set operations on the XQParameters object.

Method Summary

java.lang.String	getName() Get the name of this parameter info.
java.lang.String	getRef() Get the reference value for this parameter info.
int	getType() Get the type of this parameter info.
java.lang.String	getValue() Get the String value for this parameter info.
java.lang.Object	getValueObject() Get the Object value for this parameter info.
boolean	hasValue() Check if this parameter has a value defined.

Methods inherited from interface com.sonicsw.xq.XQCloneable

clone

Method Detail

getName

java.lang.String getName()

Get the name of this parameter info.

Returns:

the name of this parameter.

getType

int getType()

Get the type of this parameter info.

Returns:

the type of this parameter. Either PARAMS_STRING, PARAMS_XML or PARAMS_OBJECT.

getRef

java.lang.String getRef()

Get the reference value for this parameter info. References are either to XQ Directory service resources (e.g. sonicfs:///) or to external resources (e.g. http://). If the parameter has a reference defined then the value for this parameter will be read from that reference instead of from any other value when requesting the value object

Returns:

the reference defined for this parameter info.

getValue

java.lang.String getValue()

Get the String value for this parameter info. If a String value has been defined then that value will be returned. If a String value of null was specified then the valueObject will be obtained and returned if it results in a String object.

Returns:

the String value for this parameter

getValueObject

java.lang.Object getValueObject()

Get the Object value for this parameter info. If a reference has been specified then the value will be obtained from that reference and parsed into the correct Object type (based on the parameter type). Otherwise the String value for the parameter will be used and parsed into the correct Object type.

Returns:

the Object value for this parameter.

hasValue

boolean hasValue()

Check if this parameter has a value defined. A value is defined if it has a String value, an Object value or a reference value.

Returns:

true if this parameter has a value