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

Class AbstractPreActionResource

java.lang.Object

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

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

All Implemented Interfaces:

RestResource

Direct Known Subclasses:

AbstractActionResource, ExamEditResource, InputEditResource, MergeResource

public abstract class AbstractPreActionResource
extends AbstractRestResource

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

Modifier and Type	Class	Description
static enum	AbstractPreActionResource.SelectionType	Define which type of selection the action resource expects.

Field Summary

Fields

Modifier and Type	Field	Description
protected BusinessUnitManager	businessUnitManager
protected Context	context
protected DefaultDisplayService	defaultDisplayService
protected EntityDefaultValueService	defaultValueService
protected FormBeanService	formBeanService
protected final String	initialFormEntityName
protected final String	initialFormName
protected L10N	l10n
protected org.slf4j.Logger	log
protected final boolean	requiresFormEntity
protected SecurityManager	securityManager
protected TextResources	textResources

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

uriInfo

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPreActionResource(AbstractPreActionResource.SelectionType selectionType)
protected	AbstractPreActionResource(AbstractPreActionResource.SelectionType selectionType, @Nullable String initialFormEntityName)
protected	AbstractPreActionResource(AbstractPreActionResource.SelectionType selectionType, @Nullable String initialFormEntityName, @Nullable String initialFormName)

Method Summary

Modifier and Type	Method	Description
protected InitialFormValueResponseBean	getInitialFormValueResponseBean(String formName)
protected PrimaryKeyList	getSelectedEntities(EntitySelectionBean selection)
protected Entity	getSelectedEntity(EntitySelectionBean selection)
protected InitialFormValueResponseBean	loadInitialForm()
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
void	setBusinessUnitManager(BusinessUnitManager businessUnitManager)
void	setContext(Context context)
void	setDefaultDisplayService(DefaultDisplayService defaultDisplayService)
void	setDefaultValueService(EntityDefaultValueService defaultValueService)
void	setFormBeanService(FormBeanService formBeanService)
void	setL10n(L10N l10n)
void	setLog(org.slf4j.Logger log)
void	setSecurityManager(SecurityManager securityManager)
void	setSelectionService(SelectionService selectionService)
void	setTextResources(TextResources textResources)

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

Field Details

context

protected Context context

textResources

protected TextResources textResources

log

protected org.slf4j.Logger log

formBeanService

protected FormBeanService formBeanService

l10n

protected L10N l10n

businessUnitManager

protected BusinessUnitManager businessUnitManager

securityManager

protected SecurityManager securityManager

defaultValueService

protected EntityDefaultValueService defaultValueService

defaultDisplayService

protected DefaultDisplayService defaultDisplayService

requiresFormEntity

protected final boolean requiresFormEntity

initialFormEntityName

protected final String initialFormEntityName

initialFormName

protected final String initialFormName

Constructor Details

AbstractPreActionResource

protected AbstractPreActionResource(AbstractPreActionResource.SelectionType selectionType)

AbstractPreActionResource

protected AbstractPreActionResource(AbstractPreActionResource.SelectionType selectionType,
 @Nullable
 @Nullable String initialFormEntityName)

AbstractPreActionResource

protected AbstractPreActionResource(AbstractPreActionResource.SelectionType selectionType,
 @Nullable
 @Nullable String initialFormEntityName,
 @Nullable
 @Nullable String initialFormName)

Method Details

preAction

@POST
@Path("/check")
@Consumes("application/json")
@Produces("application/json")
public 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

loadInitialForm

protected InitialFormValueResponseBean loadInitialForm()

getInitialFormValueResponseBean

protected InitialFormValueResponseBean getInitialFormValueResponseBean(String formName)

getSelectedEntity

protected Entity getSelectedEntity(EntitySelectionBean selection)
                            throws NotFoundException

Throws:

NotFoundException

getSelectedEntities

protected PrimaryKeyList getSelectedEntities(EntitySelectionBean selection)
                                      throws NotFoundException

Throws:

NotFoundException

setContext

@Autowired
public void setContext(Context context)

setTextResources

@Autowired
public void setTextResources(TextResources textResources)

setLog

@Autowired
public void setLog(org.slf4j.Logger log)

setSelectionService

@Autowired
public void setSelectionService(SelectionService selectionService)

setFormBeanService

@Autowired
public void setFormBeanService(FormBeanService formBeanService)

setL10n

@Autowired
public void setL10n(L10N l10n)

setBusinessUnitManager

@Autowired
public void setBusinessUnitManager(BusinessUnitManager businessUnitManager)

setSecurityManager

@Autowired
public void setSecurityManager(SecurityManager securityManager)

setDefaultValueService

@Autowired
public void setDefaultValueService(EntityDefaultValueService defaultValueService)

setDefaultDisplayService

@Autowired
public void setDefaultDisplayService(DefaultDisplayService defaultDisplayService)