org.jwarp.service.param
Interface IParameterDescription

All Superinterfaces:

IConfigurable

All Known Implementing Classes:

ParameterDescription

public interface IParameterDescription

extends IConfigurable

A parameter description holds information about a parameter such as the requirements of its presence or requirements to its value. There is no parameter value here.

Method Summary

java.lang.String	getDescription() Returns the parameter's description.
boolean	getMaybeEmpty() Can the parameters value be empty.
java.lang.String	getName() Returns the parameters name
boolean	getRequired() Is the parameter required?
IValidator	getValidator() Get a validator that validates this kind of parameter.

Methods inherited from interface org.jwarp.service.configuration.IConfigurable

configure

Method Detail

getName

public java.lang.String getName()

Returns the parameters name

Returns:

The name

getDescription

public java.lang.String getDescription()

Returns the parameter's description.

Returns:

The description

getRequired

public boolean getRequired()

Is the parameter required? The question is about the existence of the parameter at all in a parameter list. E.g. an id parameter must be given when the operation should update a data record in a relational db table.

Returns:

true if the parameter is required.

getMaybeEmpty

public boolean getMaybeEmpty()

Can the parameters value be empty. This is independent from the required attribute since a parameter can be not required (existence) but when present its value can not be empty.

Returns:

true if the value of the parameter can be empty.

getValidator

public IValidator getValidator()

Get a validator that validates this kind of parameter.

Returns:

A corresponding validator instance