Package ch.tocco.nice2.reporting.impl.rest

Class ReportGenerationResource

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.reporting.impl.rest.ReportGenerationResource

All Implemented Interfaces:

RestResource

@Path("/report/generations")
public class ReportGenerationResource
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

Constructor	Description
ReportGenerationResource(ReportGenerationService reportGenerationService, OrderingParser orderingParser)

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 CallableType	getCallableType()	per default the callable type (persisted as Task_execution) is DATA_PROCESSING.
protected Class<? extends AbstractJob>	getJobClass()	each action resource needs an empty job class as inner class which either implements AbstractActionJob or AbstractInterruptableActionJob.
ActionResponseBean	performAction(ActionResourceBean actionResourceBean)
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	recoveryEnabled()	Override to disable recovery for a particular action resource.
void	setReportSettingsEntities(List<ReportSettingsEntityContribution> contributions)
protected TextMessage	taskFailedMessage()
protected TextMessage	taskFailedTitle()
protected TextMessage	taskFinishedMessage()
protected TextMessage	taskSchedulingMessage()
protected TextMessage	taskStartedMessage()
protected boolean	verifyFormEntityBean(EntityBean formEntityBean)

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

doValidate, getCurrentUsername, getFormEntity, getParentEntity, getTaskData, setCommandExecutor, setEntityBeanRebinder, setNotificationService, setTaskContextBuilder, setTaskSchedulingService, taskCancelledMessage, 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

ReportGenerationResource

public ReportGenerationResource(ReportGenerationService reportGenerationService,
 OrderingParser orderingParser)

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

performAction

public ActionResponseBean performAction(ActionResourceBean actionResourceBean)

Overrides:

performAction in class AbstractActionResource

doPerformAction

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

Specified by:

doPerformAction in class AbstractActionResource

getCallableType

protected CallableType getCallableType()

Description copied from class: AbstractActionResource

per default the callable type (persisted as Task_execution) is DATA_PROCESSING. however for some action a more specific type can be set

Overrides:

getCallableType 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

taskSchedulingMessage

protected TextMessage taskSchedulingMessage()

Overrides:

taskSchedulingMessage in class AbstractActionResource

taskStartedMessage

protected TextMessage taskStartedMessage()

Overrides:

taskStartedMessage in class AbstractActionResource

taskFinishedMessage

protected TextMessage taskFinishedMessage()

Overrides:

taskFinishedMessage in class AbstractActionResource

taskFailedMessage

protected TextMessage taskFailedMessage()

Overrides:

taskFailedMessage in class AbstractActionResource

taskFailedTitle

protected TextMessage taskFailedTitle()

Overrides:

taskFailedTitle in class AbstractActionResource

verifyFormEntityBean

protected boolean verifyFormEntityBean(EntityBean formEntityBean)

Overrides:

verifyFormEntityBean 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

recoveryEnabled

protected boolean recoveryEnabled()

Description copied from class: AbstractActionResource

Override to disable recovery for a particular action resource.

Overrides:

recoveryEnabled in class AbstractActionResource

Returns:

true if the job should be recovered after Nice restart, else false (default: true)

setReportSettingsEntities

@Autowired
public void setReportSettingsEntities(List<ReportSettingsEntityContribution> contributions)