net.ontopia.topicmaps.webed.core

Interface ActionParametersIF

All Known Implementing Classes:

ActionParameters

public interface ActionParametersIF

PUBLIC: Contains the parameters of an action.

Method Summary

Modifier and Type	Method and Description
ActionParametersIF	cloneAndOverride(List newparams) EXPERIMENTAL: Creates clones the ActionParametersIF object, overriding the parameter list to the given list.
Object	get(int ix) PUBLIC: Returns the value of the numbered parameter as a single object.
boolean	getBooleanValue() PUBLIC: Returns true if the parameter value was 'on'; used with checkboxes to tell if the box was checked or not.
Collection	getCollection(int ix) PUBLIC: Returns the value of the numbered parameter as a collection containing all the parameter values.
FileValueIF	getFileValue() PUBLIC: Returns the parameter value as a file, if it was given as a file.
int	getParameterCount() PUBLIC: Returns the number of parameters.
WebEdRequestIF	getRequest() PUBLIC: Returns the web editor request that triggered this action.
String	getStringValue() PUBLIC: Returns the string value of the request parameter that matched this action.
String[]	getStringValues() PUBLIC: Returns the string values of the request parameter that matched this action.
TMObjectIF	getTMObjectValue() PUBLIC: Interprets the string value as a topic map object ID and returns that topic map object.
Collection	getTMObjectValues() PUBLIC: Interprets the string value as a set of topic map object IDs and returns a collection of topic map objects.

Method Detail

get

Object get(int ix)

PUBLIC: Returns the value of the numbered parameter as a single object. If the parameter had multiple values only the first will be returned.

Parameters:

ix - The index of the parameter, counting from 0.

Returns:

The first object in the collection, or null if it is empty.

getCollection

Collection getCollection(int ix)

PUBLIC: Returns the value of the numbered parameter as a collection containing all the parameter values.

Parameters:

ix - The index of the parameter, counting from 0.

Returns:

The entire collection.

getParameterCount

int getParameterCount()

PUBLIC: Returns the number of parameters.

Since:

2.0

getStringValue

String getStringValue()

PUBLIC: Returns the string value of the request parameter that matched this action. If there is more than one value only the first will be returned.

getStringValues

String[] getStringValues()

PUBLIC: Returns the string values of the request parameter that matched this action.

getTMObjectValue

TMObjectIF getTMObjectValue()

PUBLIC: Interprets the string value as a topic map object ID and returns that topic map object. Mainly used for selection lists and suchlike.

getTMObjectValues

Collection getTMObjectValues()

PUBLIC: Interprets the string value as a set of topic map object IDs and returns a collection of topic map objects. Mainly used for selection lists and suchlike.

getFileValue

FileValueIF getFileValue()

PUBLIC: Returns the parameter value as a file, if it was given as a file. If not, returns null.

Since:

2.0

getBooleanValue

boolean getBooleanValue()

PUBLIC: Returns true if the parameter value was 'on'; used with checkboxes to tell if the box was checked or not.

Since:

2.0

getRequest

WebEdRequestIF getRequest()

PUBLIC: Returns the web editor request that triggered this action.

Since:

2.0

cloneAndOverride

ActionParametersIF cloneAndOverride(List newparams)

EXPERIMENTAL: Creates clones the ActionParametersIF object, overriding the parameter list to the given list. This is useful for calling existing actions from custom actions.

Parameters:

newparams - The new parameter list. Each element in the list must be a java.util.Collection containing the value(s) for the parameter at that position.

Since:

2.1