com.edorasware.api.action

Class ActionBuilder

java.lang.Object

com.edorasware.api.action.ActionBuilder

@Experimental
public class ActionBuilder
extends Object

Builds a new Action using a fluent API.

Method Summary

Modifier and Type	Method and Description
Action	build() Builds the Action instance.
ActionBuilder	buttonLabel(String buttonLabel) Sets the button label.
ActionBuilder	buttonLabelKey(String buttonLabelKey) Sets the i18n message key for the action button label.
ActionBuilder	description(String description) Sets the action description.
ActionBuilder	enabled(boolean enabled) Sets the action 'enabled' state.
ActionBuilder	endpoint(String endpoint) Sets the URL for the REST endpoint to be invoked when the action is triggered.
ActionBuilder	endpointHttpMethod(HttpMethod endpointHttpMethod) Sets the HttpMethod to be used for the action endpoint invocation.
ActionBuilder	form(String form) Sets the key for the action form.
ActionBuilder	group(String group) Sets the action group information.
ActionBuilder	hidden(boolean hidden) Sets the action 'hidden' state.
ActionBuilder	icon(String icon) Sets the icon key.
ActionBuilder	id(String id) Sets the action ID.
ActionBuilder	name(String name) Sets the action name.
ActionBuilder	nameKey(String nameKey) Sets the i18n message key for the action name.
ActionBuilder	url(String url) Sets the navigation URL.
ActionBuilder	workObject(Optional<WorkObject> workObject) Sets the optional referenced work object.
ActionBuilder	workObject(WorkObject workObject) Sets the referenced work object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

id

public ActionBuilder id(String id)

Sets the action ID.

Parameters:

id - the action ID

Returns:

the builder

nameKey

public ActionBuilder nameKey(String nameKey)

Sets the i18n message key for the action name.

Parameters:

nameKey - the i18n message key

Returns:

the builder

name

public ActionBuilder name(String name)

Sets the action name.

Note	this value may be overwritten by the translated i18n message key

Parameters:

name - the action name

Returns:

the builder

buttonLabelKey

public ActionBuilder buttonLabelKey(String buttonLabelKey)

Sets the i18n message key for the action button label.

Parameters:

buttonLabelKey - the i18n message key

Returns:

the builder

buttonLabel

public ActionBuilder buttonLabel(String buttonLabel)

Sets the button label.

Note	this value may be overwritten by the translated i18n message key

Parameters:

buttonLabel - the button label

Returns:

the builder

description

public ActionBuilder description(String description)

Sets the action description.

Parameters:

description - the action description

Returns:

the builder

icon

public ActionBuilder icon(String icon)

Sets the icon key.

Parameters:

icon - the icon key

Returns:

the builder

hidden

public ActionBuilder hidden(boolean hidden)

Sets the action 'hidden' state.

Parameters:

hidden - the action 'hidden' state

Returns:

the builder

enabled

public ActionBuilder enabled(boolean enabled)

Sets the action 'enabled' state.

Parameters:

enabled - the action 'enabled' state

Returns:

the builder

url

public ActionBuilder url(String url)

Sets the navigation URL.

The value should be relative to the server base URL (e.g. "#/dashboard/user"). If the action was successful then the browser will navigate to the given URL.

Parameters:

url - the navigation URL

Returns:

the builder

form

public ActionBuilder form(String form)

Sets the key for the action form.

This form will be shown before the action is executed.

Parameters:

form - the form key

Returns:

the builder

endpointHttpMethod

public ActionBuilder endpointHttpMethod(HttpMethod endpointHttpMethod)

Sets the HttpMethod to be used for the action endpoint invocation.

Parameters:

endpointHttpMethod - the HttpMethod value

Returns:

the builder

endpoint

public ActionBuilder endpoint(String endpoint)

Sets the URL for the REST endpoint to be invoked when the action is triggered.

The URL may either be relative to the base server URL (e.g. "acme/ping") or an absolute URL (e.g. "http://acme.com/ping").

Parameters:

endpoint - the REST endpoint URL

Returns:

the builder

group

public ActionBuilder group(String group)

Sets the action group information.

Parameters:

group - the action group

Returns:

the builder

workObject

public ActionBuilder workObject(WorkObject workObject)

Sets the referenced work object.

Parameters:

workObject - the referenced work object

Returns:

the builder

workObject

public ActionBuilder workObject(Optional<WorkObject> workObject)

Sets the optional referenced work object.

Parameters:

workObject - the optional referenced work object

Returns:

the builder

build

public Action build()

Builds the Action instance.

Returns:

the Action instance