com.edorasware.api.action

Interface Action

@Experimental
public interface Action

Interface for a work object action.

Action instances can be built using an ActionBuilder.

Method Summary

Modifier and Type	Method and Description
static ActionBuilder	builder() Creates a new action builder.
static ActionBuilder	builder(Action template) Creates a new action builder based on the given template action.
String	getButtonLabel() Returns the button label.
String	getButtonLabelKey() Returns the button label i18n message key.
String	getDescription() Returns the action description.
String	getEndpoint() The action REST endpoint (relative to the server base URL).
HttpMethod	getEndpointHttpMethod() The HttpMethod to be used when the action REST endpoint is invoked.
String	getForm() Returns the form key.
String	getGroup() Returns the grouping information for this action.
String	getIcon() Returns the icon key.
String	getId() Returns the action ID.
String	getName() Returns the action name.
String	getNameKey() Returns the action name i18n message key.
String	getUrl() Returns the navigation URL to be used when the action is completed.
Optional<WorkObject>	getWorkObject() Returns the optional work object associated with this action.
boolean	isEnabled() Returns the 'enabled' state.
boolean	isHidden() Returns the 'hidden' state.
boolean	isRequired() Returns the 'required' state.

Method Detail

getId

String getId()

Returns the action ID.

Returns:

the action ID

getNameKey

String getNameKey()

Returns the action name i18n message key.

Returns:

the action name i18n message key

getName

String getName()

Returns the action name.

Returns:

the action name

getForm

String getForm()

Returns the form key.

This method may return null if no form is required.

Returns:

the form key

getEndpointHttpMethod

HttpMethod getEndpointHttpMethod()

The HttpMethod to be used when the action REST endpoint is invoked.

Returns:

the http method

getEndpoint

String getEndpoint()

The action REST endpoint (relative to the server base URL).

Returns:

the action REST endpoint

getButtonLabelKey

String getButtonLabelKey()

Returns the button label i18n message key.

Returns:

the button label i18n message key

getButtonLabel

String getButtonLabel()

Returns the button label.

Returns:

the button label

getIcon

String getIcon()

Returns the icon key.

Returns:

the icon key

getDescription

String getDescription()

Returns the action description.

Returns:

the action description

isEnabled

boolean isEnabled()

Returns the 'enabled' state.

Returns:

true if the action is enabled

isHidden

boolean isHidden()

Returns the 'hidden' state.

Returns:

true if the action is hidden

isRequired

boolean isRequired()

Returns the 'required' state.

Returns:

true if the action is required

getUrl

String getUrl()

Returns the navigation URL to be used when the action is completed.

The return value should be relative to the server base URL, e.g. "#/dashboard/user". Complete URLs (e.g. https://foo.com) are not supported.

Returns:

the navigation URL

getGroup

String getGroup()

Returns the grouping information for this action.

Returns:

the grouping information

getWorkObject

Optional<WorkObject> getWorkObject()

Returns the optional work object associated with this action.

Returns:

the optional work object

builder

static ActionBuilder builder()

Creates a new action builder.

Returns:

the new action builder

builder

static ActionBuilder builder(Action template)

Creates a new action builder based on the given template action.

Returns:

the new action builder