Package ch.tocco.nice2.rest.action.spi

Class AbstractCustomActionResource

java.lang.Object

ch.tocco.nice2.rest.core.spi.AbstractRestResource

ch.tocco.nice2.rest.action.spi.AbstractActionResource

ch.tocco.nice2.rest.action.spi.AbstractCustomActionResource

All Implemented Interfaces:

RestResource

Direct Known Subclasses:

EvaluationViewResource, EvaluationViewTreeResource, ExamEditResource, InputEditResource, MergeResource, PaymentProviderActionResource

public abstract class AbstractCustomActionResource
extends AbstractActionResource

Abstract base class for custom action resources with some pre-action logic. If the custom action should just start a React app with no logic before it, then this class does not necessarily need to be extended.

Nested Class Summary

Nested classes/interfaces inherited from class ch.tocco.nice2.rest.action.spi.AbstractActionResource

AbstractActionResource.AbstractActionJob, AbstractActionResource.AbstractInterruptableActionJob, AbstractActionResource.ActionMessageConfig, AbstractActionResource.ActionResultBean, AbstractActionResource.ActionResultBeanBuilder, AbstractActionResource.ActionResultFlags, AbstractActionResource.GetFormEntityTask, AbstractActionResource.SelectionType

Field Summary

Fields inherited from class ch.tocco.nice2.rest.action.spi.AbstractActionResource

businessUnitManager, commandExecutor, context, defaultDisplayService, defaultValueService, entityBeanRebinder, formBeanService, l10n, log, notificationService, securityManager, taskSchedulingService, textResources

Fields inherited from class ch.tocco.nice2.rest.core.spi.AbstractRestResource

uriInfo

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCustomActionResource(AbstractActionResource.SelectionType selectionType)

Method Summary

Modifier and Type	Method	Description
protected TextMessage	actionName()	name of the action displayed in the notification center if no specific text is set
protected final AbstractActionResource.ActionResultBean	doPerformAction(ActionDataBean actionDataBean, ActionResourceBean actionResourceBean, TaskContext taskContext)
protected Class<? extends AbstractJob>	getJobClass()	each action resource needs an empty job class as inner class which either implements AbstractActionJob or AbstractInterruptableActionJob.
final ActionResponseBean	performAction(ActionResourceBean actionResourceBean)

Methods inherited from class ch.tocco.nice2.rest.action.spi.AbstractActionResource

formEntityMissing, getCallableType, getCurrentUsername, getInitialFormValueResponseBean, getParentEntity, getSelectedEntities, getSelectedEntity, getTaskData, ignoreMissingEntities, loadInitialForm, preAction, recoveryEnabled, setBusinessUnitManager, setCommandExecutor, setContext, setDefaultDisplayService, setDefaultValueService, setEntityBeanRebinder, setFormBeanService, setL10n, setLog, setNotificationService, setSecurityManager, setSelectionService, setTaskSchedulingService, setTextResources, taskCancelledMessage, taskFailedMessage, taskFailedTitle, taskFinishedMessage, taskSchedulingMessage, taskStartedMessage, verifyFormEntityBean

Methods inherited from class ch.tocco.nice2.rest.core.spi.AbstractRestResource

getPathParameter, setUriInfo, tryGetInt

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractCustomActionResource

protected AbstractCustomActionResource(AbstractActionResource.SelectionType selectionType)

Method Details

doPerformAction

protected final AbstractActionResource.ActionResultBean doPerformAction(ActionDataBean actionDataBean,
 ActionResourceBean actionResourceBean,
 TaskContext taskContext)

Specified by:

doPerformAction in class AbstractActionResource

performAction

public final ActionResponseBean performAction(ActionResourceBean actionResourceBean)

Overrides:

performAction in class AbstractActionResource

actionName

protected TextMessage actionName()

Description copied from class: AbstractActionResource

name of the action displayed in the notification center if no specific text is set

Specified by:

actionName in class AbstractActionResource

getJobClass

protected Class<? extends AbstractJob> getJobClass()

Description copied from class: AbstractActionResource

each action resource needs an empty job class as inner class which either implements AbstractActionJob or AbstractInterruptableActionJob. the class is needed to run the job in the task scheduler. if AbstractInterruptableActionJob is used the doPerformAction must implement a cancellation handling

Specified by:

getJobClass in class AbstractActionResource