Package ch.tocco.nice2.optional.order.api.action.invoice.tasks

Class InvokeOrderGeneratorTask

java.lang.Object

ch.tocco.nice2.tasks.api.quartz.AbstractJob

ch.tocco.nice2.tasks.api.quartz.AbstractInterruptableJob

ch.tocco.nice2.optional.order.api.action.invoice.tasks.InvokeOrderGeneratorTask

All Implemented Interfaces:

org.quartz.InterruptableJob, org.quartz.Job

Direct Known Subclasses:

BillingPositionInvoiceActionServiceImpl.BillingPositionInvokeOrderGeneratorTask, DefaultInvoiceActionServiceImpl.DefaultInvokeOrderGeneratorTask, DirectInvoiceActionServiceImpl.DirectInvokeOrderGeneratorTask

public abstract class InvokeOrderGeneratorTask
extends AbstractInterruptableJob

Task that invokes the OrderGeneratorService for a selection of entities. Different contexts are used for every batch of entities to avoid high memory usage.

However before the selection can be split up into batches, the selection must be grouped by recipient so that the orders can be merged together within the same transaction.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InvokeOrderGeneratorTask.Recipient

Field Summary

Fields

Modifier and Type	Field	Description
protected final CommandExecutor	commandExecutor
protected final ContextManager	contextManager
protected final DataModel	dataModel
protected final OrderGeneratorService	orderGeneratorService
protected final QueryBuilderFactory	queryBuilderFactory
protected final RebindService	rebindService
protected final EntityExplorerActionSelectionService	selectionService
protected final TextResources	textResources
protected final ValidationResultPrinter	validationResultPrinter

Fields inherited from class ch.tocco.nice2.tasks.api.quartz.AbstractJob

businessUnitManager, l10N, logger, principalManager, securityManager

Constructor Summary

Constructors

Constructor	Description
InvokeOrderGeneratorTask(ContextManager contextManager, RebindService rebindService, OrderGeneratorService orderGeneratorService, TextResources textResources, ValidationResultPrinter validationResultPrinter, CommandExecutor commandExecutor, DataModel dataModel, EntityExplorerActionSelectionService selectionService, QueryBuilderFactory queryBuilderFactory)

Method Summary

Modifier and Type	Method	Description
protected List<OrderGeneratorBean>	createOrderGeneratorBeans(com.google.common.collect.Multimap<InvokeOrderGeneratorTask.Recipient,EntityId> recipients, Context newContext)
protected void	doExecute(org.quartz.JobExecutionContext context, JobDataMapReader jobDataMapReader)
protected List<OrderGeneratorBean>	generateOrders(JobDataMapReader jobDataMapReader, com.google.common.collect.Multimap<InvokeOrderGeneratorTask.Recipient,EntityId> recipients, Context newContext)
protected abstract List<Entity>	getBillingPositions(Entity source)	Returns all billing positions for a given source entity.
protected abstract List<PrimaryKeyList>	getSourceEntities(EntityList selection, int maxTxSize)	The selected entities for which the action should be performed.
protected List<PrimaryKeyList>	getSourceEntities(JobDataMapReader jobDataMapReader, int maxTxSize)	The selected entities for which the action should be performed.
protected void	newContextEnded(Context context)	Hook for subclasses to perform cleanup before a context is closed.
protected void	newContextStarted(Context context, JobDataMapReader jobData)	Hook for subclasses to perform initialization for a new context.

Methods inherited from class ch.tocco.nice2.tasks.api.quartz.AbstractInterruptableJob

interrupt, isCancelled

Methods inherited from class ch.tocco.nice2.tasks.api.quartz.AbstractJob

execute, getProgress, getProgressLog, setBusinessUnitManager, setConverters, setL10N, setLogger, setPrincipalManager, setProgressPersistenceManager, setRuleProviderService, setSecurityManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.quartz.Job

execute

Field Details

contextManager

protected final ContextManager contextManager

rebindService

protected final RebindService rebindService

orderGeneratorService

protected final OrderGeneratorService orderGeneratorService

textResources

protected final TextResources textResources

validationResultPrinter

protected final ValidationResultPrinter validationResultPrinter

commandExecutor

protected final CommandExecutor commandExecutor

dataModel

protected final DataModel dataModel

selectionService

protected final EntityExplorerActionSelectionService selectionService

queryBuilderFactory

protected final QueryBuilderFactory queryBuilderFactory

Constructor Details

InvokeOrderGeneratorTask

public InvokeOrderGeneratorTask(ContextManager contextManager,
 RebindService rebindService,
 OrderGeneratorService orderGeneratorService,
 TextResources textResources,
 ValidationResultPrinter validationResultPrinter,
 CommandExecutor commandExecutor,
 DataModel dataModel,
 EntityExplorerActionSelectionService selectionService,
 QueryBuilderFactory queryBuilderFactory)

Method Details

doExecute

protected void doExecute(org.quartz.JobExecutionContext context,
 JobDataMapReader jobDataMapReader)

Specified by:

doExecute in class AbstractJob

generateOrders

protected List<OrderGeneratorBean> generateOrders(JobDataMapReader jobDataMapReader,
 com.google.common.collect.Multimap<InvokeOrderGeneratorTask.Recipient,EntityId> recipients,
 Context newContext)
                                           throws UnresolvableUriException,
UriStoreException,
URISyntaxException,
RebindException

Throws:

UnresolvableUriException

UriStoreException

URISyntaxException

RebindException

createOrderGeneratorBeans

protected List<OrderGeneratorBean> createOrderGeneratorBeans(com.google.common.collect.Multimap<InvokeOrderGeneratorTask.Recipient,EntityId> recipients,
 Context newContext)

newContextStarted

protected void newContextStarted(Context context,
 JobDataMapReader jobData)
                          throws Exception

Hook for subclasses to perform initialization for a new context.

Throws:

Exception

newContextEnded

protected void newContextEnded(Context context)
                        throws Exception

Hook for subclasses to perform cleanup before a context is closed.

Throws:

Exception

getSourceEntities

protected List<PrimaryKeyList> getSourceEntities(JobDataMapReader jobDataMapReader,
 int maxTxSize)

The selected entities for which the action should be performed.

getSourceEntities

protected abstract List<PrimaryKeyList> getSourceEntities(EntityList selection,
 int maxTxSize)

The selected entities for which the action should be performed.

getBillingPositions

protected abstract List<Entity> getBillingPositions(Entity source)

Returns all billing positions for a given source entity.