public final class FunctionSpec extends Object
Modifier and Type | Method and Description |
---|---|
int |
getCache()
Gets the number of seconds the result of this method could be cached.
|
String |
getDescription()
Gets the description of the function.
|
ErrorCodeSpec |
getErrorCode(String errorCodeName)
Gets the error code specification for the specified error code.
|
Map<String,ErrorCodeSpec> |
getErrorCodes()
Gets the error code specifications defined in the function.
|
DataSectionElementSpec |
getInputDataSectionElement(String elementName)
Gets the specification of the element of the input data section with the
specified name.
|
Map<String,DataSectionElementSpec> |
getInputDataSectionElements()
Gets the specification of the elements of the input data section.
|
List<ParamComboSpec> |
getInputParamCombos()
Gets the input param combo specifications.
|
ParameterSpec |
getInputParameter(String parameterName)
Gets the input parameter for the specified name.
|
Map<String,ParameterSpec> |
getInputParameters()
Gets the input parameter specifications defined in the function.
|
String |
getName()
Gets the name of the function.
|
DataSectionElementSpec |
getOutputDataSectionElement(String elementName)
Gets the specification of the element of the output data section with the
specified name.
|
Map<String,DataSectionElementSpec> |
getOutputDataSectionElements()
Gets the specification of the elements of the output data section.
|
List<ParamComboSpec> |
getOutputParamCombos()
Gets the output param combo specifications.
|
ParameterSpec |
getOutputParameter(String parameterName)
Gets the output parameter of the specified name.
|
Map<String,ParameterSpec> |
getOutputParameters()
Gets the output parameter specifications defined in the function.
|
void |
setCache(int cache)
Sets the number of seconds the result of this method could be cached.
|
public String getName()
null
.public int getCache()
0
if the result should not be cached.public void setCache(int cache)
cache
- the number of seconds the result of this method could be cached,
or 0
if the result should not be cached.public String getDescription()
null
.public ParameterSpec getInputParameter(String parameterName) throws EntityNotFoundException, IllegalArgumentException
parameterName
- the name of the parameter, cannot be null
.null
.EntityNotFoundException
- if the function does not contain any input parameter with the specified name.IllegalArgumentException
- if parameterName == null
.public Map<String,ParameterSpec> getInputParameters()
ParameterSpec
object.null
.public ParameterSpec getOutputParameter(String parameterName) throws IllegalArgumentException, EntityNotFoundException
parameterName
- the name of the parameter, cannot be null
.null
.IllegalArgumentException
- if parameterName == null
.EntityNotFoundException
- if the function does not contain any output parameter with the specified name.public Map<String,ParameterSpec> getOutputParameters()
ParameterSpec
object.null
.public ErrorCodeSpec getErrorCode(String errorCodeName) throws IllegalArgumentException, EntityNotFoundException
errorCodeName
- the name of the error code, cannot be null
.null
.IllegalArgumentException
- if errorCodeName == null
.EntityNotFoundException
- if the function does not define any error code with the specified name.public Map<String,ErrorCodeSpec> getErrorCodes()
ErrorCodeSpec
object.null
.public DataSectionElementSpec getInputDataSectionElement(String elementName) throws IllegalArgumentException, EntityNotFoundException
elementName
- the name of the element, cannot be null
.null
.IllegalArgumentException
- if elementName == null
.EntityNotFoundException
- if the function does not define any input data element with the specified name.public Map<String,DataSectionElementSpec> getInputDataSectionElements()
DataSectionElementSpec
object.null
.public DataSectionElementSpec getOutputDataSectionElement(String elementName) throws IllegalArgumentException, EntityNotFoundException
elementName
- the name of the element, cannot be null
.null
.IllegalArgumentException
- if elementName == null
.EntityNotFoundException
- if the function does not define any output data element with the specified name.public Map<String,DataSectionElementSpec> getOutputDataSectionElements()
DataSectionElementSpec
object.null
.public List<ParamComboSpec> getInputParamCombos()
ParamComboSpec
), never null
.public List<ParamComboSpec> getOutputParamCombos()
ParamComboSpec
), never null
.See http://www.xins.org/.