public interface Parameter
Modifier and Type | Method and Description |
---|---|
DataType |
getDataType()
Get the data type of this parameter, for example "string".
|
java.lang.String |
getDescription()
Get a description of this parameter.
|
java.lang.String |
getFormat()
Get the format of this parameter, for example "int32".
|
java.lang.String |
getName()
Get the name of this parameter, for example "customerId".
|
Operation |
getOperation()
Get the Operation that owns this parameter.
|
ParameterType |
getType()
Get the type of this parameter, for example "QUERY".
|
boolean |
isRequired()
Determine whether or not this parameter is required.
|
Parameter |
setDataType(DataType type)
Set the data type of this parameter, for example "boolean".
|
Parameter |
setDescription(java.lang.String description)
Set the description of this parameter.
|
Parameter |
setFormat(java.lang.String format)
Set the format of this parameter, for example "float".
|
Parameter |
setName(java.lang.String name)
Set the name of this parameter, for example "customerId".
|
Parameter |
setRequired(boolean required)
Specify whether or not his parameter is required.
|
Parameter |
setType(ParameterType type)
Set the type of this parameter, for example "FORM".
|
java.lang.String getName()
Parameter setName(java.lang.String name) throws ApiException
name
- the new name of this parameter.ApiException
- if the name could not be changed.Operation getOperation()
ParameterType getType()
Parameter setType(ParameterType type) throws ApiException
type
- the new type of this parameter.ApiException
- if the type could not be changed.java.lang.String getFormat()
Parameter setFormat(java.lang.String format) throws ApiException
format
- the new format of this parameter.ApiException
- if the format could not be changed.boolean isRequired()
Parameter setRequired(boolean required) throws ApiException
required
- true if this parameter is required, false if it is optional.ApiException
- if the flag could not be changed.java.lang.String getDescription()
Parameter setDescription(java.lang.String description) throws ApiException
description
- the new description of this parameter.ApiException
- if the description could not be changed.DataType getDataType()
Parameter setDataType(DataType type) throws ApiException
type
- the new data type of this parameter.ApiException
- if the type could not be changed.