org.apache.manifoldcf.core.interfaces

Interface IParameterActivity

All Known Subinterfaces:

IPostParameters

All Known Implementing Classes:

MultipartWrapper

public interface IParameterActivity

This interface represents parameters that get posted during UI interaction.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid

Method Summary

Modifier and Type	Method and Description
byte[]	getBinaryBytes(java.lang.String name) Get file parameter, as a byte array.
BinaryInput	getBinaryStream(java.lang.String name) Get a file parameter, as a binary input stream.
java.lang.String	getParameter(java.lang.String name) Get single parameter value.
java.lang.String[]	getParameterValues(java.lang.String name) Read an array of parameter values.
void	setParameter(java.lang.String name, java.lang.String value) Set a parameter value.
void	setParameterValues(java.lang.String name, java.lang.String[] values) Set an array of parameter values.

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

Method Detail

getParameterValues

java.lang.String[] getParameterValues(java.lang.String name)

Read an array of parameter values.

Parameters:

name - is the parameter name.

Returns:

the array of values, or null if it doesn't exist.

getParameter

java.lang.String getParameter(java.lang.String name)

Get single parameter value.

Parameters:

name - is the parameter name.

Returns:

the value, or null if it doesn't exist.

getBinaryStream

BinaryInput getBinaryStream(java.lang.String name)
                     throws ManifoldCFException

Get a file parameter, as a binary input stream.

Parameters:

name - is the parameter name.

Returns:

the value, or null if it doesn't exist.

Throws:

ManifoldCFException

getBinaryBytes

byte[] getBinaryBytes(java.lang.String name)

Get file parameter, as a byte array.

Parameters:

name - is the parameter name.

Returns:

the binary parameter as an array of bytes.

setParameter

void setParameter(java.lang.String name,
                  java.lang.String value)

Set a parameter value.

Parameters:

name - is the parameter name.

value - is the desired value.

setParameterValues

void setParameterValues(java.lang.String name,
                        java.lang.String[] values)

Set an array of parameter values.

Parameters:

name - is the parameter name.

values - is the array of desired values.