Package ch.tocco.nice2.model.form.api.form2.components

Interface Action

All Superinterfaces:

BaseAction, Cloneable, Component, CompositeComponent

All Known Implementing Classes:

ActionImpl

public interface Action
extends BaseAction

Nested Class Summary

Nested classes/interfaces inherited from interface ch.tocco.nice2.model.form.api.form2.components.BaseAction

BaseAction.ActionType, BaseAction.ButtonStyle, BaseAction.ModalSize

Nested classes/interfaces inherited from interface ch.tocco.nice2.model.form.api.form2.components.Component

Component.Configuration

Method Summary

Modifier and Type	Method	Description
@Nullable String	getAppId()	The app with this id will be called by the action.
BaseAction.ButtonStyle	getButtonStyle()	used to decide the look of an action button
ButtonType	getButtonType()	used to decide the look of an action
String	getConditionName()	Name of the action condition used to decide if action is shown
String	getDmsEntityModel()	used to determine on which dms items to display an action
@Nullable String	getEndpoint()	This REST endpoint will be called by the action.
@Nullable String	getPath()	The legacy action with this path will be called.
Map<String,Object>	getProperties()	The properties for the action.
UseLabel	getUseLabel()	used to determine whether the label should be displayed
boolean	isOnlyShowOnEmptyColumn()
boolean	isPlaceholder()	Returns true if an action is only a placeholder.

Methods inherited from interface ch.tocco.nice2.model.form.api.form2.components.BaseAction

getActionType, getConfirmationThreshold, getIcon, getMaxSelection, getMinSelection, getModalSize, getShowConfirmation, isCancelConfirmation, isFullscreen, isRunInBackgroundTask, usesLabelAsTextResource

Methods inherited from interface ch.tocco.nice2.model.form.api.form2.components.Component

accept, getForm, getId, getLabel, getParent, getPosition, validate

Methods inherited from interface ch.tocco.nice2.model.form.api.form2.components.CompositeComponent

findById, getChildren, getScopes, hasChildren

Method Details

getEndpoint

@Nullable
@Nullable String getEndpoint()

This REST endpoint will be called by the action. Must be defined if the action type is equal BaseAction.ActionType.SIMPLE. It can also be set on BaseAction.ActionType.CUSTOM for pre-action logic.

getAppId

@Nullable
@Nullable String getAppId()

The app with this id will be called by the action. Must only be defined if the action type is equal BaseAction.ActionType.CUSTOM

getPath

@Nullable
@Nullable String getPath()

The legacy action with this path will be called. Must only be defined if the action type is equal BaseAction.ActionType.LEGACY

getUseLabel

UseLabel getUseLabel()

used to determine whether the label should be displayed

getDmsEntityModel

String getDmsEntityModel()

used to determine on which dms items to display an action

getButtonType

ButtonType getButtonType()

used to decide the look of an action

getButtonStyle

BaseAction.ButtonStyle getButtonStyle()

used to decide the look of an action button

getProperties

Map<String,Object> getProperties()

The properties for the action. The value can either be of type string, boolean or number.

isOnlyShowOnEmptyColumn

boolean isOnlyShowOnEmptyColumn()

getConditionName

String getConditionName()

Name of the action condition used to decide if action is shown

isPlaceholder

boolean isPlaceholder()

Returns true if an action is only a placeholder. A placeholder is only available during using FormInterceptors. The last FormInterceptor RemovePlaceholderInterceptor removes such placeholders. Placeholders are required to define the sorting (e.g. "after:delete"). Else during sorting sometimes errors are logged.