Package ch.tocco.nice2.optional.ruleschedule.impl.actions

Class CreateScheduleActionResource

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.optional.ruleschedule.impl.actions.CreateScheduleActionResource

All Implemented Interfaces:

RestResource

@Path("/ruleschedule/actions/createSchedule")
public class CreateScheduleActionResource
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

Modifier and Type	Field	Description
static final String	EMPTY_RULE_SCHEDULE_MESSAGE_KEY
static final String	END_EVENT_MESSAGE_KEY
static final String	INACTIVE_RULE_SCHEDULE_MESSAGE_KEY
static final String	NO_RULE_SCHEDULE_MESSAGE_KEY
static final String	START_EVENT_MESSAGE_KEY
static final String	SUCCESS_MESSAGE_KEY

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	CreateScheduleActionResource(QueryBuilderFactory queryBuilderFactory, RuleScheduleReservationService ruleScheduleReservationService, EventRelationshipTraverser eventRelationshipTraverser)

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 PreActionResponseBean	doValidate(ActionResourceBean actionResourceBean, ActionDataBean actionDataBean)
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

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

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

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

Field Details

NO_RULE_SCHEDULE_MESSAGE_KEY

public static final String NO_RULE_SCHEDULE_MESSAGE_KEY

See Also:

• Constant Field Values

INACTIVE_RULE_SCHEDULE_MESSAGE_KEY

public static final String INACTIVE_RULE_SCHEDULE_MESSAGE_KEY

See Also:

• Constant Field Values

EMPTY_RULE_SCHEDULE_MESSAGE_KEY

public static final String EMPTY_RULE_SCHEDULE_MESSAGE_KEY

See Also:

• Constant Field Values

END_EVENT_MESSAGE_KEY

public static final String END_EVENT_MESSAGE_KEY

See Also:

• Constant Field Values

START_EVENT_MESSAGE_KEY

public static final String START_EVENT_MESSAGE_KEY

See Also:

• Constant Field Values

SUCCESS_MESSAGE_KEY

public static final String SUCCESS_MESSAGE_KEY

See Also:

• Constant Field Values

Constructor Details

CreateScheduleActionResource

protected CreateScheduleActionResource(QueryBuilderFactory queryBuilderFactory,
 RuleScheduleReservationService ruleScheduleReservationService,
 EventRelationshipTraverser eventRelationshipTraverser)

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

doValidate

protected PreActionResponseBean doValidate(ActionResourceBean actionResourceBean,
 ActionDataBean actionDataBean)

Overrides:

doValidate in class AbstractActionResource

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