org.jwarp.service.param
Class InParameter

java.lang.Object
  |
  +--org.jwarp.service.param.Property
        |
        +--org.jwarp.service.param.Parameter
              |
              +--org.jwarp.service.param.InParameter

All Implemented Interfaces:

IInParameter, IParameter, IProperty

Direct Known Subclasses:

WorkParameter

public class InParameter

extends Parameter

implements IInParameter

Class implementing a parameter.

Field Summary

(package private) short

paramType

Fields inherited from class org.jwarp.service.param.Parameter

metadata

Fields inherited from class org.jwarp.service.param.Property

name, value

Fields inherited from interface org.jwarp.service.param.IInParameter

PARAMTYPE_IN, PARAMTYPE_INOUT, PARAMTYPE_OUT

Constructor Summary

InParameter(IParameterDescription metadata, java.lang.Object value)
Constructs a new parameter given the meta data and the value.

InParameter(IParameterDescription metadata, java.lang.Object value, short paramtype)
Constructs a new parameter given the meta data and the value.

InParameter(java.lang.String name, java.lang.Object value)
Constructs a new parameter given the meta data and the value.

Method Summary

short	getParamType() Returns the parameter's metadata.
void	setValue(java.lang.Object object) Set a new value.

Methods inherited from class org.jwarp.service.param.Parameter

getMetaData, getName

Methods inherited from class org.jwarp.service.param.Property

getAsBoolean, getAsDouble, getAsFloat, getAsInteger, getAsLong, getAsString, getValue, getValue, setName

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jwarp.service.param.IParameter

getMetaData

Methods inherited from interface org.jwarp.service.param.IProperty

getAsBoolean, getAsDouble, getAsFloat, getAsInteger, getAsLong, getAsString, getName, getValue, getValue

Field Detail

paramType

short paramType

Constructor Detail

InParameter

public InParameter(java.lang.String name,
                   java.lang.Object value)
            throws ParameterException

Constructs a new parameter given the meta data and the value. The value is validated with the meta data's validator, so a ParameterException is thrown if the validation failed. The parameter type will be PARAMTYPE_INOUT.

Parameters:

metadata - The parameter's meta data

value - The parameters value

Throws:

ParameterException - If the validation of the value fails.

InParameter

public InParameter(IParameterDescription metadata,
                   java.lang.Object value)
            throws ParameterException

Constructs a new parameter given the meta data and the value. The value is validated with the meta data's validator, so a ParameterException is thrown if the validation failed. The parameter type will be PARAMTYPE_INOUT.

Parameters:

metadata - The parameter's meta data

value - The parameters value

Throws:

ParameterException - If the validation of the value fails.

InParameter

public InParameter(IParameterDescription metadata,
                   java.lang.Object value,
                   short paramtype)
            throws ParameterException

Constructs a new parameter given the meta data and the value. The value is validated with the meta data's validator, so a ParameterException is thrown if the validation failed.

Parameters:

metadata - The parameter's meta data

value - The parameters value

paramType - The type of the parameter (PARAMTYPE_IN, PARAMTYPE_OUT, PARAMTYPE_INOUT)

Throws:

ParameterException - If the validation of the value fails.

Method Detail

setValue

public void setValue(java.lang.Object object)
              throws ParameterException

Set a new value.

Specified by:

setValue in interface IProperty

Overrides:

setValue in class Property

Parameters:

The - new value

Throws:

ParameterException - Raise if the validation of the new value failes or the parameter is only a IN-parameter (read-only).

getParamType

public short getParamType()

Description copied from interface: IInParameter

Returns the parameter's metadata.

Specified by:

getParamType in interface IInParameter

Following copied from interface: org.jwarp.service.param.IInParameter

Returns:

The meta data.