org.jboss.managed.api
Interface ManagedParameter

All Superinterfaces:

Serializable

All Known Implementing Classes:

ManagedParameterImpl

public interface ManagedParameter
extends Serializable

A representation of a ManagedOperation parameter

Version:

$Revision: 64930 $

Author:

Scott.Stark@jboss.org

Method Summary

String	checkValidValue(Serializable value) Check whether this is a valid value
String	getDescription() Get the description
<T> T	getField(String fieldName, Class<T> expected) Get a field
Fields	getFields() Get the fields
Set<org.jboss.metatype.api.values.MetaValue>	getLegalValues() Get the legal values
Comparable	getMaximumValue() Get the miximum value
org.jboss.metatype.api.types.MetaType	getMetaType() Get the type
Comparable	getMinimumValue() Get the minimum value
String	getName() Get the property's name
Object	getValue() Get the value
void	setField(String fieldName, Serializable value) Set a field
void	setValue(Serializable value) Set the value

Method Detail

getFields

Fields getFields()

Get the fields

Returns:

the fields

getField

<T> T getField(String fieldName,
               Class<T> expected)

Get a field

Type Parameters:

T - the expected type

Parameters:

fieldName - the field name

expected - the expected type

Returns:

the value

setField

void setField(String fieldName,
              Serializable value)

Set a field

Parameters:

fieldName - the field name

value - the value

getName

String getName()

Get the property's name

Returns:

the property's name

getDescription

String getDescription()

Get the description

Returns:

the description

getMetaType

org.jboss.metatype.api.types.MetaType getMetaType()

Get the type

Returns:

the type

getValue

Object getValue()

Get the value

Returns:

the value

setValue

void setValue(Serializable value)

Set the value

Parameters:

value - the value

getLegalValues

Set<org.jboss.metatype.api.values.MetaValue> getLegalValues()

Get the legal values

Returns:

the legal values

getMinimumValue

Comparable getMinimumValue()

Get the minimum value

Returns:

the minimum value

getMaximumValue

Comparable getMaximumValue()

Get the miximum value

Returns:

the maximum value

checkValidValue

String checkValidValue(Serializable value)

Check whether this is a valid value

Parameters:

value - the value

Returns:

null for a valid value, an error message otherwise