org.jboss.managed.api
Interface ManagedParameter

All Superinterfaces:
Serializable, TransientAttachments
All Known Implementing Classes:
ManagedParameterImpl

public interface ManagedParameter
extends Serializable, TransientAttachments

A representation of a ManagedOperation parameter

Version:
$Revision: 87004 $
Author:
Scott.Stark@jboss.org

Method Summary
 String checkValidValue(MetaValue 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<MetaValue> getLegalValues()
          Get the legal values
 Comparable<?> getMaximumValue()
          Get the miximum value
 MetaType getMetaType()
          Get the type
 Comparable<?> getMinimumValue()
          Get the minimum value
 String getName()
          Get the property's name
 MetaValue getValue()
          Get the value
 void setField(String fieldName, Serializable value)
          Set a field
 void setValue(MetaValue value)
          Set the value
 
Methods inherited from interface org.jboss.managed.api.TransientAttachments
getTransientAttachment, getTransientAttachment, setTransientAttachment
 

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

MetaType getMetaType()
Get the type

Returns:
the type

getValue

MetaValue getValue()
Get the value

Returns:
the value

setValue

void setValue(MetaValue value)
Set the value

Parameters:
value - the value

getLegalValues

Set<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(MetaValue value)
Check whether this is a valid value

Parameters:
value - the value
Returns:
null for a valid value, an error message otherwise


Copyright © 2009 JBoss, a division of Red Hat, Inc.. All Rights Reserved.