com.axemble.vdoc.sdk.interfaces

Interface IPluginRequest

All Superinterfaces:

Serializable

public interface IPluginRequest
extends Serializable

The plugin request interface.

Since:

2.0, 02/02/2010

Author:

vlygeros

Method Summary

Modifier and Type	Method and Description
String	convertToString() Converts the inner value to a string.
String	getParameterValue(String key) Gets a parameter by its key.
String[]	getParameterValues(String key) Gets all the values associated with a key.
String	getQueryString() Gets the requested string.
String	getRequestURI() Gets the requested URI
String	getRequestURL() Gets the requested URL
void	setParameterValue(String key, String value) Sets the value for the specified parameter.
void	setParameterValues(String key, String[] values) Sets the values associated with a key.

Method Detail

getRequestURL

String getRequestURL()

Gets the requested URL

Returns:

A java.lang.String value.

getRequestURI

String getRequestURI()

Gets the requested URI

Returns:

A java.lang.String value.

getQueryString

String getQueryString()

Gets the requested string.

Returns:

The requested string as a java.lang.String object.

getParameterValue

String getParameterValue(String key)

Gets a parameter by its key.

Parameters:

key - The key of the parameter.

Returns:

The parameter associated with the key.

setParameterValue

void setParameterValue(String key,
                       String value)

Sets the value for the specified parameter.

Parameters:

key - The key of the parameter.

value - The value of the parameter.

getParameterValues

String[] getParameterValues(String key)

Gets all the values associated with a key.

Parameters:

key - The key of the parameters.

Returns:

All the values associated with the key.

setParameterValues

void setParameterValues(String key,
                        String[] values)

Sets the values associated with a key.

Parameters:

key - The key of the parameter.

values - The values to set.

convertToString

String convertToString()

Converts the inner value to a string.

Returns:

a java.lang.String value.