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

Interface EffectiveRecipient

All Known Implementing Classes:

EffectiveRecipientImpl

public interface EffectiveRecipient

EffectiveRecipient is a wrapper for a Person or Address entity to be used as delegate for the ConcernedRecipient.

See Also:

• ConcernedRecipient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Optional<Entity>	getAddress()
@Nullable String	getAddressDisplay()	Returns the DefaultDisplay of the address if available.
@Nullable String	getAddressForOutput()	Returns the Address as used when generating output if available.
EffectiveRecipient.ClientRepresentation	getClientRepresentation()	Returns a simple representation of the EffectiveRecipient to be used in client UI.
ConcernedRecipient	getConcernedRecipient()
Entity	getEffectiveEntity()
Optional<String>	getEmailAddress()
Optional<Entity>	getPerson()
@Nullable String	getPersonDisplay()	Returns the DefaultDisplay of the person if available.
@Nullable String	getSalutationForOutput()	Returns the Saluation as used when generating output if available.
boolean	isValid()	Checks if this EffectiveRecipient is valid for the given CommunicationType by checking the presence of addressData or emailData, which is gathered from the underlying entity.
void	setAddressForOutput(String addressForOutput)
void	setSalutationForOutput(String salutationForOutput)

Method Details

isValid

boolean isValid()

Checks if this EffectiveRecipient is valid for the given CommunicationType by checking the presence of addressData or emailData, which is gathered from the underlying entity.

Returns:

true if valid, false otherwise

See Also:

• ConcernedRecipient.isValid()

getPerson

Optional<Entity> getPerson()

getAddress

Optional<Entity> getAddress()

getEffectiveEntity

Entity getEffectiveEntity()

getEmailAddress

Optional<String> getEmailAddress()

getPersonDisplay

@Nullable
@Nullable String getPersonDisplay()

Returns the DefaultDisplay of the person if available. Otherwise null.

getAddressDisplay

@Nullable
@Nullable String getAddressDisplay()

Returns the DefaultDisplay of the address if available. Otherwise null.

getSalutationForOutput

@Nullable
@Nullable String getSalutationForOutput()

Returns the Saluation as used when generating output if available. Otherwise null.

setAddressForOutput

void setAddressForOutput(String addressForOutput)

getAddressForOutput

@Nullable
@Nullable String getAddressForOutput()

Returns the Address as used when generating output if available. Otherwise null.

setSalutationForOutput

void setSalutationForOutput(String salutationForOutput)

getClientRepresentation

EffectiveRecipient.ClientRepresentation getClientRepresentation()
                                                         throws PersistException

Returns a simple representation of the EffectiveRecipient to be used in client UI.

Returns:

the simple EffectiveRecipient representation

Throws:

PersistException

getConcernedRecipient

ConcernedRecipient getConcernedRecipient()