Package ch.tocco.nice2.optional.address.impl.action.mail

Class MailArgs

java.lang.Object

ch.tocco.nice2.optional.address.impl.action.mail.MailArgs

public final class MailArgs
extends Object

Constructor Summary

Constructors

Constructor	Description
MailArgs(MailActionService.MailInfo mailInfo, EntityExplorerActionSelection selection, boolean fixateReceiverListFeature)
MailArgs(MailActionService.MailInfo mailInfo, EntityExplorerActionSelection selection, EntityExplorerActionSelection receiverSelection, boolean fixateReceiverListFeature)

Method Summary

Modifier and Type	Method	Description
MailActionService.MailInfo	getMailInfo()
List<MailReceiver>	getMailReceivers()
EntityExplorerActionSelection	getSelection()
EntityList	getSelectionEntityList()
Entity	getSender()
boolean	isFixateReceiverListFeature()
MailArgs	load(CommandExecutor executor, EntityExplorerActionSelectionService selectionService, MailReceiverService mailReceiverService, Context persistCtx, boolean isFirstBatch)	Load required data.
MailArgs	loadNew(Context persistCtx, EntityExplorerActionSelectionService selectionService, MailReceiverService mailReceiverService, boolean isFirstBatch)	Load all required data “the old way”, don't fixate the selection etc.
MailArgs	loadPrepared(CommandExecutor executor, EntityExplorerActionSelectionService selectionService)	Used inside the send-mail task: After this object is deserialized it is in the state after a call to prepare(CommandExecutor, EntityExplorerActionSelectionService, MailReceiverService).
MailArgs	prepare(CommandExecutor executor, EntityExplorerActionSelectionService selectionService, MailReceiverService mailReceiverService)	Prepare the arguments by creating the list of receivers.

Methods inherited from class java.lang.Object

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

Constructor Details

MailArgs

public MailArgs(MailActionService.MailInfo mailInfo,
 EntityExplorerActionSelection selection,
 boolean fixateReceiverListFeature)

MailArgs

public MailArgs(MailActionService.MailInfo mailInfo,
 EntityExplorerActionSelection selection,
 EntityExplorerActionSelection receiverSelection,
 boolean fixateReceiverListFeature)

Method Details

prepare

public MailArgs prepare(CommandExecutor executor,
 EntityExplorerActionSelectionService selectionService,
 MailReceiverService mailReceiverService)
                 throws NoEntityToLoadException

Prepare the arguments by creating the list of receivers. The list is then stored in this class. The lists are serialized into the JobDataMap object when a send-mail task is submitted.

Throws:

NoEntityToLoadException

getMailInfo

public MailActionService.MailInfo getMailInfo()

getSelection

public EntityExplorerActionSelection getSelection()

getSender

public Entity getSender()

getSelectionEntityList

public EntityList getSelectionEntityList()

getMailReceivers

public List<MailReceiver> getMailReceivers()

isFixateReceiverListFeature

public boolean isFixateReceiverListFeature()

loadPrepared

public MailArgs loadPrepared(CommandExecutor executor,
 EntityExplorerActionSelectionService selectionService)

Used inside the send-mail task: After this object is deserialized it is in the state after a call to prepare(CommandExecutor, EntityExplorerActionSelectionService, MailReceiverService). Then this method re-fetches the receiver list based on the stored primary keys.

loadNew

public MailArgs loadNew(Context persistCtx,
 EntityExplorerActionSelectionService selectionService,
 MailReceiverService mailReceiverService,
 boolean isFirstBatch)
                 throws NoEntityToLoadException

Load all required data “the old way”, don't fixate the selection etc. This is to provide the old behaviour.

Throws:

NoEntityToLoadException

load

public MailArgs load(CommandExecutor executor,
 EntityExplorerActionSelectionService selectionService,
 MailReceiverService mailReceiverService,
 Context persistCtx,
 boolean isFirstBatch)
              throws NoEntityToLoadException

Load required data. It checks whether the fixate-feature is enabeld and uses the corresponding way of loading the data by delegating to either loadPrepared(CommandExecutor, EntityExplorerActionSelectionService) or loadNew(Context, EntityExplorerActionSelectionService, MailReceiverService, boolean).

Throws:

NoEntityToLoadException