Package ch.tocco.nice2.reporting.impl.action.export

Class ExportActionResource

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.action.export.ExportActionResource

All Implemented Interfaces:

RestResource

@Path("/action/export")
public class ExportActionResource
extends AbstractActionResource

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ExportActionResource.Column
static final record	ExportActionResource.ExportData
static final record	ExportActionResource.ExportFormData
static final record	ExportActionResource.TemplatePaths
static final record	ExportActionResource.TemplateValue

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
ExportActionResource(ExportHelperService exportHelperService, DataModel dataModel, PersistenceService persistenceService, 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.
ExportActionResource.TemplatePaths	loadAdditionalPaths(ExportActionResource.TemplateValue value)
ExportActionResource.ExportFormData	loadFormData(EntitySelectionBean selection)

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

doValidate, 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, preAction, 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

ExportActionResource

public ExportActionResource(ExportHelperService exportHelperService,
 DataModel dataModel,
 PersistenceService persistenceService,
 OrderingParser orderingParser)

Method Details

loadFormData

@POST
@Path("/formData")
@Consumes("application/json")
@Produces("application/json")
public ExportActionResource.ExportFormData loadFormData(EntitySelectionBean selection)

loadAdditionalPaths

@POST
@Path("/templatePaths")
@Consumes("application/json")
@Produces("application/json")
public ExportActionResource.TemplatePaths loadAdditionalPaths(ExportActionResource.TemplateValue value)

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

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

doPerformAction

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

Specified by:

doPerformAction in class AbstractActionResource