Interface ActionDescription
-
@ProviderType public interface ActionDescription
A description of an action registered in a model.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Iterable<ActionFieldDescription>
getFields()
Get the descriptions of the fields the action is expecting.java.lang.String
getName()
Get the name of the action.java.lang.String
getResourcePath()
The resource path the action can be called against.java.lang.String
getTitle()
Get the title of the action.java.lang.String
getType()
Get the content type of the request that the action expects.java.lang.String
getVerb()
Get the HTTP verb the action is registered against.boolean
isDefault()
Get whether the action is considered the default.
-
-
-
Method Detail
-
getVerb
@Nonnull java.lang.String getVerb()
Get the HTTP verb the action is registered against.- Returns:
- The HTTP verb
-
getName
@Nonnull java.lang.String getName()
Get the name of the action.- Returns:
- The name of the action.
-
getTitle
@CheckForNull java.lang.String getTitle()
Get the title of the action.- Returns:
- The title of the action.
-
getType
@CheckForNull java.lang.String getType()
Get the content type of the request that the action expects.- Returns:
- The content type of the request.
-
isDefault
boolean isDefault()
Get whether the action is considered the default. Default actions are used to handle requests that cannot be matched to a more specific non-default action registered in the model. There can be one default action per HTTP verb.- Returns:
- Whether the action is a default action.
-
getResourcePath
@CheckForNull java.lang.String getResourcePath()
The resource path the action can be called against.- Returns:
- The resource path.
-
getFields
@CheckForNull java.lang.Iterable<ActionFieldDescription> getFields()
Get the descriptions of the fields the action is expecting.- Returns:
- The descriptions of the fields.
-
-