OpenAPI 1.0

com.aquafold.openapi.chart
Interface AQFunctionParameter


public interface AQFunctionParameter

FunctionParameter

Synopsis:

A FunctionParameter is a parameter for a SeriesFunction.

Description:
FunctionParameter provides a interface for getting and setting the name, value and data type of a parameter being passed to a SeriesFunction.


Nested Class Summary
static class AQFunctionParameter.DataType
          Supported parameter datatypes: Integer, Float, Double
 
Method Summary
 AQFunctionParameter.DataType getDataType()
          Get the parameter's datatype (Integer, Float or Double)
 String getName()
          Get the name of the parameter.
 Object getValue()
          Get the value of the parameter.
 String getValueString()
          Get a string representation of the parameter value.
 boolean isDouble()
          Return TRUE if the parameter is a Double.
 boolean isFloat()
          Return TRUE if the parameter is a Float.
 boolean isInteger()
          Return TRUE if the parameter is an Integer.
 boolean isOptional()
          Return True if the parameter is optional
 void setDataType(AQFunctionParameter.DataType dataType)
          Set the parameter's datatype (Integer, Float or Double)
 void setName(String name)
          Set the name of the parameter.
 void setValue(Object value)
          Set the value of the parameter.
 boolean setValueFromString(String valueString)
          Use a string to set the value of the parameter.
 

Method Detail

getName

String getName()
Get the name of the parameter.

Returns:
Parameter name

setName

void setName(String name)
Set the name of the parameter.

Parameters:
name - Parameter name

getValueString

String getValueString()
Get a string representation of the parameter value.

Returns:
String representation of parameter value

getValue

Object getValue()
Get the value of the parameter.

Returns:
Parameter value

setValue

void setValue(Object value)
Set the value of the parameter.

Parameters:
value - Parameter value

setValueFromString

boolean setValueFromString(String valueString)
Use a string to set the value of the parameter.

Parameters:
valueString - String representation of parameter value
Returns:
True if parameter value is successfully set

getDataType

AQFunctionParameter.DataType getDataType()
Get the parameter's datatype (Integer, Float or Double)

Returns:
DataType of parameter

setDataType

void setDataType(AQFunctionParameter.DataType dataType)
Set the parameter's datatype (Integer, Float or Double)

Parameters:
dataType - DataType of parameter

isInteger

boolean isInteger()
Return TRUE if the parameter is an Integer.

Returns:
True if the parameter is an Integer

isFloat

boolean isFloat()
Return TRUE if the parameter is a Float.

Returns:
True if the parameter is a Float

isDouble

boolean isDouble()
Return TRUE if the parameter is a Double.

Returns:
True if the parameter is a Double

isOptional

boolean isOptional()
Return True if the parameter is optional

Returns:
True if the parameter is optional

OpenAPI 1.0


Copyright © 2010 AquaFold, Inc. All Rights Reserved. Use is subject to license terms.