Package ch.tocco.nice2.optional.address.api.recipient

Interface RecipientService

All Known Implementing Classes:

RecipientServiceImpl

public interface RecipientService

RecipientService to retrieve all ConcernedRecipients and their EffectiveRecipient. See package information for a detailed description of the functionality provided by this service and it's data model.

See Also:

• RecipientActionService
• RecipientParameters
• ConcernedRecipient
• EffectiveRecipient

Method Summary

Modifier and Type	Method	Description
List<CommunicationTarget>	getRecipientsByTarget(EntityList selection, RecipientParameters parameters)	Evaluates and returns all EffectiveRecipients arranged as a list of CommunicationTargets based on the selected entities and the provided RecipientParameters.
List<ConcernedRecipient>	getUnmergedRecipients(EntityList selection, RecipientParameters parameters)	Returns all ConcernedRecipients for the provided selection of Entitys based on the RecipientParameters without merging them.

Method Details

getUnmergedRecipients

List<ConcernedRecipient> getUnmergedRecipients(EntityList selection,
 RecipientParameters parameters)
                                        throws NoEntityToLoadException

Returns all ConcernedRecipients for the provided selection of Entitys based on the RecipientParameters without merging them. This can be used to display (as done in the correspondence dialog) and check the whole collection of targeted EffectiveRecipients before they are merged according to the corresponding RecipientParameters.mergeRecipientsByTarget flag.

Parameters:

selection - the list entities for which the EffectiveRecipients will be calculated

parameters - the RecipientParameters

Returns:

the ConcernedRecipients with all ConcernedRecipients and their EffectiveRecipients

Throws:

NoEntityToLoadException

See Also:

• RecipientParameters.isMergeRecipientsByTarget()

getRecipientsByTarget

List<CommunicationTarget> getRecipientsByTarget(EntityList selection,
 RecipientParameters parameters)
                                         throws NoEntityToLoadException

Evaluates and returns all EffectiveRecipients arranged as a list of CommunicationTargets based on the selected entities and the provided RecipientParameters.

Parameters:

selection - the list entities for which the EffectiveRecipients will be calculated

parameters - the RecipientParameters

Returns:

the EffectiveRecipients arranged as a list of CommunicationTargets

Throws:

NoEntityToLoadException