org.proteios.core.plugin

Interface ParameterValues

public interface ParameterValues

This interface is used by the plugin to access the different parameters attached to its job and configuration.

Version:

2.0

Author:

Enell

Last modified

$Date: 2009-04-09 08:48:11 +0200 (Thu, 09 Apr 2009) $

Method Summary

Methods

Modifier and Type	Method and Description
int	getId() Get the ID of the job or configuration the parameters comes from.
Object	getValue(String name) Get a single value for a specific parameter.
List<?>	getValues(String name) Get a List of values for a specific parameter.
<T> void	setValue(String name, ParameterType<T> type, T value) Set a single value for a parameter.
<T> void	setValues(String name, ParameterType<T> type, List<T> values) Set a list of values for a parameter.

Method Detail

getId

int getId()

Get the ID of the job or configuration the parameters comes from.

getValue

Object getValue(String name)
                throws PermissionDeniedException,
                       BaseException

Get a single value for a specific parameter. If the parameter has more then one value only the first value is returned. Use getValues(String) to return all values as a list.

Parameters:

name - the name of the parameter

Returns:

The value or null if no parameter with that name is found

Throws:

PermissionDeniedException - If the logged in user doesn't have permission to read the value

BaseException - If there is another error

getValues

List<?> getValues(String name)
                  throws PermissionDeniedException,
                         BaseException

Get a List of values for a specific parameter.

Parameters:

name - The name of the parameter

Returns:

The values or null if no parameter with that name is found

Throws:

PermissionDeniedException - If the logged in user doesn't have permission to read the values

BaseException - If there is another error

setValue

<T> void setValue(String name,
                ParameterType<T> type,
                T value)
              throws PermissionDeniedException,
                     InvalidDataException,
                     BaseException

Set a single value for a parameter. The core will store the value at the appropriate place in the database. Ie. as a configuration value to either the plugin or job configuration. If the configuration settings are write protected because the plugin received an execute command the settings will not be changed.

Parameters:

name - The name of the parameter

type - The type of the value

value - The value to be set

Throws:

PermissionDeniedException - If the logged in user doesn't have write permission

InvalidDataException - If the value is invalid according to the settings in the type

BaseException - If there is another error

setValues

<T> void setValues(String name,
                 ParameterType<T> type,
                 List<T> values)
               throws PermissionDeniedException,
                      InvalidDataException,
                      BaseException

Set a list of values for a parameter. The core will store the values at the appropriate place in the database. Ie. as a configuration value to either the plugin or job configuration. If the configuration settings are write protected because the plugin received an execute command the settings will not be changed.

Parameters:

name - The name of the parameter

type - The type of the value

values - A list containing the values

Throws:

PermissionDeniedException - If the logged in user doesn't have write permission

InvalidDataException - If any of the values is invalid according to the settings in the type

BaseException - If there is another error