Package com.adobe.granite.haf.converter.api.description

Interface ActionDescription

  • @ProviderType
public interface ActionDescription
    A description of an action registered in a model.

    • Method Detail

      • getVerb

        @Nonnull
String getVerb()
        Get the HTTP verb the action is registered against.
        Returns:
        The HTTP verb

      • getName

        @Nonnull
String getName()
        Get the name of the action.
        Returns:
        The name of the action.

      • getTitle

        @CheckForNull
String getTitle()
        Get the title of the action.
        Returns:
        The title of the action.

      • getType

        @CheckForNull
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
String getResourcePath()
        The resource path the action can be called against.
        Returns:
        The resource path.