Interface HalFormsOptions
- All Known Implementing Classes:
HalFormsOptions.AbstractHalFormsOptions
,HalFormsOptions.Inline
,HalFormsOptions.Remote
public interface HalFormsOptions
Representation of HAL-FORMS
options
attribute.- Since:
- 1.3
- Author:
- Oliver Drotbohm
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic class
static class
static class
Representation of a remote options element. -
Method Summary
Modifier and TypeMethodDescriptionReturns the maximum number of items to be selected.Returns the minimum number of items to be selected.The field to look up the prompt from.The field to use as the value to be sent.static HalFormsOptions.Inline
inline
(Collection<? extends Object> values) Creates a newHalFormsOptions.Inline
options representation listing the given collection of values.static <T> HalFormsOptions.Inline
inline
(T... values) Creates a newHalFormsOptions.Inline
options representation listing the given values.static HalFormsOptions.Remote
Creates a newHalFormsOptions.Remote
options representation using the given href.static HalFormsOptions.Remote
Creates a newHalFormsOptions.Remote
options representation using the givenLink
.
-
Method Details
-
inline
Creates a newHalFormsOptions.Inline
options representation listing the given values.- Parameters:
values
- must not be null.- Returns:
- will never be null.
-
inline
Creates a newHalFormsOptions.Inline
options representation listing the given collection of values.- Parameters:
values
- must not be null.- Returns:
- will never be null.
-
remote
Creates a newHalFormsOptions.Remote
options representation using the givenLink
.- Parameters:
link
- must not be null.- Returns:
- will never be null.
-
remote
Creates a newHalFormsOptions.Remote
options representation using the given href.- Parameters:
href
- must not be null.- Returns:
- will never be null.
-
getPromptField
The field to look up the prompt from.- Returns:
-
getValueField
The field to use as the value to be sent.- Returns:
-
getMinItems
Returns the minimum number of items to be selected.- Returns:
- null, 0 or a positive
Long
.
-
getMaxItems
Returns the maximum number of items to be selected.- Returns:
- null or a positive
Long
.
-
getSelectedValue
-