Class AbstractSetLookupEntityActionResource

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.rest.action.spi.AbstractSetLookupEntityActionResource

All Implemented Interfaces:

RestResource

public abstract class AbstractSetLookupEntityActionResource
extends AbstractActionResource

Abstract class based on AbstractActionResource.

This class provides functionality for setting a specific LookupEntity#unique_id,

• #createValidationCondition(PrimaryKeyList selection) can be overridden
• #createPreActionResponseBean() can be overridden
• #createRelationToSet() can be overridden
• #createActionResultBean() can be overridden

Nested Class Summary

Nested classes/interfaces inherited from class AbstractActionResource

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

Nested classes/interfaces inherited from class AbstractPreActionResource

AbstractPreActionResource.SelectionType

Field Summary

Fields

Modifier and Type	Field	Description
protected final QueryBuilderFactory	queryBuilderFactory

Fields inherited from class AbstractActionResource

commandExecutor, entityBeanRebinder, notificationService, taskSchedulingService

Fields inherited from class AbstractPreActionResource

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

Fields inherited from class AbstractRestResource

uriInfo

Constructor Summary

Constructors

Constructor	Description
AbstractSetLookupEntityActionResource(QueryBuilderFactory queryBuilderFactory)

Method Summary

Modifier and Type	Method	Description
protected AbstractActionResource.ActionResultBean	createActionResultBean()	No message is generated and #selectionDeleted() is not executed.
protected PreActionResponseBean	createPreActionResponseBean()	No confirm-message is generated.
protected String	createRelationToSet()	The relation that is set is retrieved by #getLookupEntityName().
protected Condition	createValidationCondition(PrimaryKeyList selection)	All selected entities need to fulfill this condition.
protected AbstractActionResource.ActionResultBean	doPerformAction(ActionDataBean actionDataBean, ActionResourceBean actionResourceBean, TaskContext taskContext)
protected abstract String	getLookupEntityName()	the model name of the lookup-entity, which is to be set
protected abstract String	getParentEntityName()	the model name of the selected entity
protected abstract String	getUniqueId()	the unique_id of the desired lookup-entity
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

Methods inherited from class AbstractActionResource

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

Methods inherited from class AbstractPreActionResource

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

Methods inherited from class AbstractRestResource

getPathParameter, setUriInfo, tryGetInt

Methods inherited from class Object

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

Field Details

queryBuilderFactory

protected final QueryBuilderFactory queryBuilderFactory

Constructor Details

AbstractSetLookupEntityActionResource

public AbstractSetLookupEntityActionResource(QueryBuilderFactory queryBuilderFactory)

Method Details

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

createValidationCondition

protected Condition createValidationCondition(PrimaryKeyList selection)

All selected entities need to fulfill this condition. This condition checks that the unique_id to be set is different from the existing one. - Override for a custom Condition

createPreActionResponseBean

protected PreActionResponseBean createPreActionResponseBean()

No confirm-message is generated. - Override for a custom confirm-message: PreCheckResponseBean.confirm(message)

createRelationToSet

protected String createRelationToSet()

The relation that is set is retrieved by #getLookupEntityName(). - Override for a relation that is different from the lookupEntity

createActionResultBean

protected AbstractActionResource.ActionResultBean createActionResultBean()

No message is generated and #selectionDeleted() is not executed. - Override for custom-message or/and if #selectionDeleted() should be executed

getParentEntityName

protected abstract String getParentEntityName()

the model name of the selected entity

getLookupEntityName

protected abstract String getLookupEntityName()

the model name of the lookup-entity, which is to be set

getUniqueId

protected abstract String getUniqueId()

the unique_id of the desired lookup-entity