|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.autonomy.utilities.NameValuePair
com.autonomy.aci.ActionParameter
ActionParameter
s are used to set the values of ACI action parameters on AciAction
s
before these are sent to an ACI server. The parameter values can be set as String
s,
int
s, long
s, float
s, double
s and boolean
s but
are always converted to String
s and URL encoded (using the character encoding set on the
AciConnection
used) before being sent to the ACI server.
Constructor Summary | |
ActionParameter()
Instantiate an empty ActionParameter . |
|
ActionParameter(java.lang.String sName,
java.util.ArrayList alValues)
Set the value of an action parameter to a list of values. |
|
ActionParameter(java.lang.String sName,
boolean bValue)
Instantiate an empty ActionParameter with the given name and boolean value. |
|
ActionParameter(java.lang.String sName,
double dValue)
Instantiate an empty ActionParameter with the given name and double value. |
|
ActionParameter(java.lang.String sName,
float fValue)
Instantiate an empty ActionParameter with the given name and float value. |
|
ActionParameter(java.lang.String sName,
int nValue)
Instantiate an empty ActionParameter with the given name and int value. |
|
ActionParameter(java.lang.String sName,
long lValue)
Instantiate an empty ActionParameter with the given name and long value. |
|
ActionParameter(java.lang.String sName,
java.lang.String sValue)
Instantiate an empty ActionParameter with the given name and String value. |
Method Summary | |
boolean |
equals(java.lang.Object o)
Test whether an object is the same as this one. |
static java.lang.String |
getSeparator()
Read the string used to separate multiple parameter values. |
static void |
setSeparator(java.lang.String sSeparator)
Change the string used to separate parameter values. |
Methods inherited from class com.autonomy.utilities.NameValuePair |
getName, getValue, setName, setValue |
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ActionParameter()
ActionParameter
. A name and value must be set on this using setName
and setValue
before the parameter is added to an AciAction
.
public ActionParameter(java.lang.String sName, java.lang.String sValue)
ActionParameter
with the given name and String
value.
sName
- the name of the action parameter.sValue
- the value of the action parameter.public ActionParameter(java.lang.String sName, int nValue)
ActionParameter
with the given name and int
value.
sName
- the name of the action parameter.nValue
- the value of the action parameter.public ActionParameter(java.lang.String sName, long lValue)
ActionParameter
with the given name and long
value.
sName
- the name of the action parameter.lValue
- the value of the action parameter.public ActionParameter(java.lang.String sName, float fValue)
ActionParameter
with the given name and float
value.
sName
- the name of the action parameter.fValue
- the value of the action parameter.public ActionParameter(java.lang.String sName, double dValue)
ActionParameter
with the given name and double
value.
sName
- the name of the action parameter.dValue
- the value of the action parameter.public ActionParameter(java.lang.String sName, boolean bValue)
ActionParameter
with the given name and boolean
value.
sName
- the name of the action parameter.bValue
- the value of the action parameter.public ActionParameter(java.lang.String sName, java.util.ArrayList alValues)
Set the value of an action parameter to a list of values. The values must be String
s and
are separated by the string given by setSeparator()
. The values are not URL escaped before
being concatenated so the caller must do this prior calling the constructor if it is necessary
(e.g multiple document references in a suggest action).
sName
- the name of the parameteralValues
- an ArrayList
of String
s giving the multiple parameter values.Method Detail |
public static void setSeparator(java.lang.String sSeparator)
sSeparator
- the value separator.public static java.lang.String getSeparator()
public boolean equals(java.lang.Object o)
ActionParameter
this means whether or
not the given objects getName()
method returns the same value as this object's
getName()
(case insensitive).
o
- the object to compare with.
getName()
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |