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

Interface ConcernedRecipient

All Known Implementing Classes:

ConcernedRecipientImpl

public interface ConcernedRecipient

ConcernedRecipient is the wrapper for the entity evaluated for communication from the entity selected in the ui. Usually the selected entity is either an Address or Person itself, or it is linked to an entity of one of those entity models as defined in the properties of the communication action. In special cases like Application, there is no such target and the address or email information is gathered from the values on the entity directly.

See Also:

• RecipientService
• EffectiveRecipient

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ConcernedRecipient.ClientRepresentation	The simple representation of a ConcernedRecipient to be used for client UI.

Method Summary

Modifier and Type	Method	Description
ConcernedRecipient.ClientRepresentation	getClientRepresentation()	Returns the client representation for this class used in the ui.
Entity	getConcernedEntity()	Returns the entity on which is wrapped by this ConcernedRecipient is based on.
RecipientParameters	getParameters()	Returns the RecipientParameters defining how the EffectiveRecipients for this ConcernedRecipient have to be resolved.
Entity	getSelectedEntity()	Returns the entity selected in the ui on which the evaluation of this ConcernedRecipients was based on.
List<CommunicationTarget>	getTargets()	Returns all CommunicationTargets evaluated for this ConcernedRecipients
boolean	isAddress()	Checks if this ConcernedRecipient is based on the User EntityModel
boolean	isPerson()	Checks if this ConcernedRecipient is based on the User EntityModel
boolean	isValid()	Checks if this ConcernedRecipient contains at least one valid EffectiveRecipient.

Method Details

isValid

boolean isValid()

Checks if this ConcernedRecipient contains at least one valid EffectiveRecipient.

Returns:

true if valid, false otherwise

See Also:

• EffectiveRecipient.isValid()

isPerson

boolean isPerson()

Checks if this ConcernedRecipient is based on the User EntityModel

Returns:

true if based on User, false otherwise

isAddress

boolean isAddress()

Checks if this ConcernedRecipient is based on the User EntityModel

Returns:

true if based on User, false otherwise

getSelectedEntity

Entity getSelectedEntity()

Returns the entity selected in the ui on which the evaluation of this ConcernedRecipients was based on.

Returns:

the originally selected entity

getConcernedEntity

Entity getConcernedEntity()

Returns the entity on which is wrapped by this ConcernedRecipient is based on. Usually it's of EntityModel User or Address, which can be checked using isPerson() and isAddress(). If it's neither of them, the communication is based on EntityModel like Application, where address/email information is gathered from a form.

Returns:

the concerned entity wrapped by this ConcernedRecipient

getTargets

List<CommunicationTarget> getTargets()

Returns all CommunicationTargets evaluated for this ConcernedRecipients

Returns:

the list of CommunicationTargets

See Also:

• CommunicationTarget

getParameters

RecipientParameters getParameters()

Returns the RecipientParameters defining how the EffectiveRecipients for this ConcernedRecipient have to be resolved.

Returns:

the RecipientParameters

getClientRepresentation

ConcernedRecipient.ClientRepresentation getClientRepresentation()

Returns the client representation for this class used in the ui.

Returns:

the client representation