Package ch.tocco.nice2.infobox.impl.infoboxconfiguration

Class InfoboxConfigurationActionResource

java.lang.Object

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

ch.tocco.nice2.rest.action.spi.AbstractPreActionResource

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

ch.tocco.nice2.infobox.impl.infoboxconfiguration.InfoboxConfigurationActionResource

All Implemented Interfaces:

RestResource

@Path("/actions/infoboxConfiguration")
public class InfoboxConfigurationActionResource
extends AbstractActionResource

Nested Class Summary

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

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

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

AbstractPreActionResource.SelectionType

Field Summary

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

commandExecutor, entityBeanRebinder, notificationService, taskSchedulingService

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

businessUnitManager, context, defaultDisplayService, defaultValueService, formBeanService, initialFormEntityName, initialFormName, l10n, log, requiresFormEntity, securityManager, textResources

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

uriInfo

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InfoboxConfigurationActionResource(L10N l10N, EntityDefaultValueService entityDefaultValueService)

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 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.
PreActionResponseBean	preAction(ActionResourceBean actionResourceBean)	is ran before the actual logic and can be used to run checks or return a form that needs to be filled before execution
protected boolean	verifyFormEntityBean(EntityBean formEntityBean)

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

doValidate, getCallableType, getCurrentUsername, getFormEntity, getParentEntity, getTaskData, performAction, recoveryEnabled, setCommandExecutor, setEntityBeanRebinder, setNotificationService, setTaskContextBuilder, setTaskSchedulingService, taskCancelledMessage, taskFailedMessage, taskFailedTitle, taskFinishedMessage, taskSchedulingMessage, taskStartedMessage, validate

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

getInitialFormValueResponseBean, getSelectedEntities, getSelectedEntity, loadInitialForm, setBusinessUnitManager, setContext, setDefaultDisplayService, setDefaultValueService, setFormBeanService, setL10n, setLog, setSecurityManager, setSelectionService, setTextResources

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

InfoboxConfigurationActionResource

protected InfoboxConfigurationActionResource(L10N l10N,
 EntityDefaultValueService entityDefaultValueService)

Method Details

verifyFormEntityBean

protected boolean verifyFormEntityBean(EntityBean formEntityBean)

Overrides:

verifyFormEntityBean in class AbstractActionResource

preAction

public PreActionResponseBean preAction(ActionResourceBean actionResourceBean)

Description copied from class: AbstractPreActionResource

is ran before the actual logic and can be used to run checks or return a form that needs to be filled before execution

Overrides:

preAction in class AbstractPreActionResource

doPerformAction

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

Specified by:

doPerformAction 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