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

Interface RecipientActionService

All Known Implementing Classes:

RecipientActionServiceImpl

public interface RecipientActionService

RecipientActionService for retrieving recipients for a selection of entities based on various criteria. If the CorrespondenceActionService or MailActionService are called in extended mode, the correspondence or mail can not only be created for the selected entities, but also for persons related to the selected entities. This way, the correspondence can be created for the concerned entity, but also for it's parents, children and so on. If the ConcernedRecipient itself is selected as one of the EffectiveRecipient, the address to use for the correspondence to the concerned entity can be chosen as well.

See Also:

• RecipientService
• ConcernedRecipient
• EffectiveRecipient

Method Summary

Modifier and Type	Method	Description
List<AddressService.AddressType.ClientRepresentation>	getOrganisationalAddressRelationTypes()	Returns the client representation of all available organisational Person-Address relation types as they can be flagged on a person-address relation like the address to which the bills are sent.
List<CommunicationRelationType>	getOrganisationalPersonRelationTypes()	Returns all available CommunicationRelationTypes (Relation Model Acceptor.
List<CommunicationRelationType>	getPersonalAddressRelationTypes()	Returns all available CommunicationRelationTypes (Relation Model User_Address_code With CommunicationRelationTypes, addresses set on a person can for example be classified as living address or vacation address.
List<CommunicationRelationType>	getPersonalPersonRelationTypes()	Returns all available CommunicationRelationTypes (Relation Model User_user_code).
List<ConcernedRecipient.ClientRepresentation>	getRecipients(EntityExplorerActionSelection selection, RecipientParameters parameters)	Returns a list with all ConcernedRecipients and their EffectiveRecipients for the selectedEntity based on the provided RecipientParameters.

Method Details

getRecipients

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

Returns a list with all ConcernedRecipients and their EffectiveRecipients for the selectedEntity based on 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 list containing all ConcernedRecipients and their EffectiveRecipients.

Throws:

NoEntityToLoadException

See Also:

• ConcernedRecipient
• EffectiveRecipient

getPersonalPersonRelationTypes

List<CommunicationRelationType> getPersonalPersonRelationTypes()

Returns all available CommunicationRelationTypes (Relation Model User_user_code). With CommunicationRelationTypes, relations between persons like student and teacher or parents and children are described.

Returns:

the list of CommunicationRelationTypes.

getOrganisationalPersonRelationTypes

List<CommunicationRelationType> getOrganisationalPersonRelationTypes()

Returns all available CommunicationRelationTypes (Relation Model Acceptor. With CommunicationRelationTypes, relations like person and the person paying the bills are described.

Returns:

the list of organisational person-person relation types.

getPersonalAddressRelationTypes

List<CommunicationRelationType> getPersonalAddressRelationTypes()

Returns all available CommunicationRelationTypes (Relation Model User_Address_code With CommunicationRelationTypes, addresses set on a person can for example be classified as living address or vacation address.

Returns:

the list of personal person-address relation types.

getOrganisationalAddressRelationTypes

List<AddressService.AddressType.ClientRepresentation> getOrganisationalAddressRelationTypes()
                                                                                     throws NoEntityToLoadException

Returns the client representation of all available organisational Person-Address relation types as they can be flagged on a person-address relation like the address to which the bills are sent. This is not an actually existing relation entity in the model, but a helper to manage various address-type flags on Address entities.

Returns:

the list of organisational person-address relation types.

Throws:

NoEntityToLoadException