Package lumis.doui.service.api.rest
Interface IDataControlRequestHelpDefinition.IRequestParameterDefinition
-
- All Known Implementing Classes:
SimpleRequestParameterDefinition
- Enclosing interface:
- IDataControlRequestHelpDefinition
public static interface IDataControlRequestHelpDefinition.IRequestParameterDefinition
Represents a request parameter definition.- Since:
- 10.4.0
- Version:
- $Revision: 21230 $ $Date: 2018-04-24 19:07:57 -0300 (Tue, 24 Apr 2018) $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getDescription()
Returns the parameter description.String
getName()
Returns the parameter name.String
getType()
Returns the parameter type.boolean
isRequired()
Returns whether the parameter is required.
-
-
-
Method Detail
-
getName
String getName()
Returns the parameter name.- Returns:
- the parameter name.
- Since:
- 10.4.0
-
getDescription
String getDescription()
Returns the parameter description.- Returns:
- the parameter description.
- Since:
- 10.4.0
-
getType
String getType()
Returns the parameter type.- Returns:
- the parameter type.
- Since:
- 10.4.0
-
isRequired
boolean isRequired()
Returns whether the parameter is required.- Returns:
- whether the parameter is required.
- Since:
- 10.4.0
-
-