Package ch.tocco.nice2.optional.correspondence.impl.action

Interface CorrespondenceActionService

All Known Implementing Classes:

CorrespondenceActionServiceImpl

public interface CorrespondenceActionService

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CorrespondenceActionService.CorrespondenceActionResult
static enum	CorrespondenceActionService.PreviewMode

Method Summary

Modifier and Type	Method	Description
CorrespondenceActionService.CorrespondenceActionResult	createPdf(RebindValue[] values, EntityExplorerActionSelection selection, RecipientParameters recipientParameters, CommunicationTarget.ClientRepresentation[] targets, @Nullable String key, @Nullable String template)	Deprecated.
CorrespondenceActionService.CorrespondenceActionResult	createPdfBackground(RebindValue[] values, EntityExplorerActionSelection selection, RecipientParameters recipientParameters, CommunicationTarget.ClientRepresentation[] targets, @Nullable String key, @Nullable String template)	Deprecated.
CorrespondenceActionService.CorrespondenceActionResult	doPreview(RebindValue[] values, EntityExplorerActionSelection selection, RecipientParameters recipientParameters, CommunicationTarget.ClientRepresentation[] targets, @Nullable String key, @Nullable String template, CorrespondenceActionService.PreviewMode previewMode)
CorrespondenceActionService.CorrespondenceActionResult	doSave(RebindValue[] values, EntityExplorerActionSelection selection, RecipientParameters recipientParameters, CommunicationTarget.ClientRepresentation[] targets, @Nullable String key, @Nullable String template)
CorrespondenceActionService.CorrespondenceActionResult	doSaveBackground(RebindValue[] values, EntityExplorerActionSelection selection, RecipientParameters recipientParameters, CommunicationTarget.ClientRepresentation[] targets, @Nullable String key, @Nullable String template)
Map<String,Object>	getCorrespondenceSignature(URI signatureId, int signatureNumber, URI localeId)	Deprecated.
@Nullable String	getDefaultOutputLanguage(EntityExplorerActionSelection selection, String path)
Integer	getNumberOfCorrespondences(String key)
List<ConcernedRecipient.ClientRepresentation>	getRecipients(EntityExplorerActionSelection selection, RecipientParameters parameters)	Returns a list of ConcernedRecipients based on the selectedEntitys and the provided RecipientParameters.
List<String>	getSelectionEntityListConfirmed(EntityExplorerActionSelection selection)
List<CommunicationTarget.ClientRepresentation>	getTargets(EntityExplorerActionSelection selection, RecipientParameters parameters)	Returns a list of CommunicationTargets based on the selectedEntitys and the provided RecipientParameters.
boolean	isShowInvalidSelectionTab()

Method Details

getCorrespondenceSignature

@Deprecated
Map<String,Object> getCorrespondenceSignature(URI signatureId,
 int signatureNumber,
 URI localeId)
                                       throws PersistException,
UnresolvableUriException,
UriStoreException

Deprecated.

Throws:

PersistException

UnresolvableUriException

UriStoreException

getRecipients

List<ConcernedRecipient.ClientRepresentation> getRecipients(EntityExplorerActionSelection selection,
 RecipientParameters parameters)
                                                     throws RpcExecutionException,
NoEntityToLoadException

Returns a list of ConcernedRecipients based on the selectedEntitys and the provided RecipientParameters. This method calls the RecipientActionService.getRecipients(ch.tocco.nice2.netui.api.actions.entityoperation.EntityExplorerActionSelection, ch.tocco.nice2.optional.address.api.recipient.RecipientParameters), but adds some special behavior for handling recipients Serial_correspondences correctly.

Parameters:

selection - the entities for which the recipients are evaluated.

parameters - the RecipientParameters providing the conditions for evaluating the recipients.

Returns:

the ConcernedRecipients contains all ConcernedRecipients and their EffectiveRecipients.

Throws:

RpcExecutionException

NoEntityToLoadException

See Also:

• ConcernedRecipient
• EffectiveRecipient

getTargets

List<CommunicationTarget.ClientRepresentation> getTargets(EntityExplorerActionSelection selection,
 RecipientParameters parameters)
                                                   throws NoEntityToLoadException

Returns a list of CommunicationTargets based on the selectedEntitys and the provided RecipientParameters.

Parameters:

selection - the entities for which the recipients are evaluated.

parameters - the RecipientParameters providing the conditions for evaluating the recipients.

Returns:

the CommunicationTargets

Throws:

NoEntityToLoadException

createPdf

@Deprecated
CorrespondenceActionService.CorrespondenceActionResult createPdf(RebindValue[] values,
 EntityExplorerActionSelection selection,
 RecipientParameters recipientParameters,
 CommunicationTarget.ClientRepresentation[] targets,
 @Nullable
 @Nullable String key,
 @Nullable
 @Nullable String template)
                                                          throws InterruptedException

Deprecated.

Throws:

InterruptedException

createPdfBackground

@Deprecated
CorrespondenceActionService.CorrespondenceActionResult createPdfBackground(RebindValue[] values,
 EntityExplorerActionSelection selection,
 RecipientParameters recipientParameters,
 CommunicationTarget.ClientRepresentation[] targets,
 @Nullable
 @Nullable String key,
 @Nullable
 @Nullable String template)
                                                                    throws InterruptedException

Deprecated.

Throws:

InterruptedException

doSave

CorrespondenceActionService.CorrespondenceActionResult doSave(RebindValue[] values,
 EntityExplorerActionSelection selection,
 RecipientParameters recipientParameters,
 CommunicationTarget.ClientRepresentation[] targets,
 @Nullable
 @Nullable String key,
 @Nullable
 @Nullable String template)
                                                       throws InterruptedException

Throws:

InterruptedException

doSaveBackground

CorrespondenceActionService.CorrespondenceActionResult doSaveBackground(RebindValue[] values,
 EntityExplorerActionSelection selection,
 RecipientParameters recipientParameters,
 CommunicationTarget.ClientRepresentation[] targets,
 @Nullable
 @Nullable String key,
 @Nullable
 @Nullable String template)
                                                                 throws InterruptedException

Throws:

InterruptedException

doPreview

CorrespondenceActionService.CorrespondenceActionResult doPreview(RebindValue[] values,
 EntityExplorerActionSelection selection,
 RecipientParameters recipientParameters,
 CommunicationTarget.ClientRepresentation[] targets,
 @Nullable
 @Nullable String key,
 @Nullable
 @Nullable String template,
 CorrespondenceActionService.PreviewMode previewMode)
                                                          throws InterruptedException

Throws:

InterruptedException

getDefaultOutputLanguage

@Nullable
@Nullable String getDefaultOutputLanguage(EntityExplorerActionSelection selection,
 String path)
                                   throws PersistException,
RpcExecutionException

Throws:

PersistException

RpcExecutionException

isShowInvalidSelectionTab

boolean isShowInvalidSelectionTab()

getSelectionEntityListConfirmed

List<String> getSelectionEntityListConfirmed(EntityExplorerActionSelection selection)
                                      throws RpcExecutionException,
PersistException

Throws:

RpcExecutionException

PersistException

getNumberOfCorrespondences

Integer getNumberOfCorrespondences(String key)