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

Class EffectiveRecipientImpl

java.lang.Object

ch.tocco.nice2.optional.address.impl.recipient.EffectiveRecipientImpl

All Implemented Interfaces:

EffectiveRecipient

public class EffectiveRecipientImpl
extends Object
implements EffectiveRecipient

EffectiveRecipientImpl

Nested Class Summary

Nested classes/interfaces inherited from interface ch.tocco.nice2.optional.address.api.recipient.EffectiveRecipient

EffectiveRecipient.ClientRepresentation

Constructor Summary

Constructors

Constructor	Description
EffectiveRecipientImpl(ConcernedRecipientImpl concernedRecipient, @Nullable Entity person, @Nullable Entity address, AddressService addressService, DefaultDisplayService defaultDisplayService)	Creates a new instance of EffectiveRecipientImpl.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
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.
int	hashCode()
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)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EffectiveRecipientImpl

public EffectiveRecipientImpl(ConcernedRecipientImpl concernedRecipient,
 @Nullable
 @Nullable Entity person,
 @Nullable
 @Nullable Entity address,
 AddressService addressService,
 DefaultDisplayService defaultDisplayService)
                       throws NoEntityToLoadException

Creates a new instance of EffectiveRecipientImpl. It can be instantiated in different ways described as follows to cover three different scenarios: Providing only the parameter for the Person entity: The EffectiveRecipientImpl will be built based on the User entity, gathering all information from it, Providing a User entity and an Address entity: The EffectiveRecipientImpl will be built based on the User entity, but using the address entity as alternative address to gather address specific information from it. Providing only a Address entity: The EffectiveRecipientImpl will be built based on the Address entity, gathering all information from it. Providing neither User, nor Address entity.: The EffectiveRecipientImpl will be built based on the selected entity, gathering all information directly from it. This is used when communication has to be created for a selection of entities without direct connection to a User or Address entity. E.g. Application entity model.

Parameters:

concernedRecipient - the ConcernedRecipientImpl this EffectiveRecipientImpl belongs to.

person - the Person entity or null if this EffectiveRecipientImpl is only a simple Address

address - the Address entity if the EffectiveRecipientImpl is not a Person or the Person's Address should be overridden.

defaultDisplayService - the DefaultDisplayService

Throws:

NoEntityToLoadException

Method Details

isValid

public boolean isValid()

Description copied from interface: EffectiveRecipient

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.

Specified by:

isValid in interface EffectiveRecipient

Returns:

true if valid, false otherwise

See Also:

• ConcernedRecipient.isValid()

getPerson

public Optional<Entity> getPerson()

Specified by:

getPerson in interface EffectiveRecipient

getAddress

public Optional<Entity> getAddress()

Specified by:

getAddress in interface EffectiveRecipient

getEffectiveEntity

public Entity getEffectiveEntity()

Specified by:

getEffectiveEntity in interface EffectiveRecipient

getEmailAddress

public Optional<String> getEmailAddress()

Specified by:

getEmailAddress in interface EffectiveRecipient

getPersonDisplay

@Nullable
public @Nullable String getPersonDisplay()

Description copied from interface: EffectiveRecipient

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

Specified by:

getPersonDisplay in interface EffectiveRecipient

getAddressDisplay

@Nullable
public @Nullable String getAddressDisplay()

Description copied from interface: EffectiveRecipient

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

Specified by:

getAddressDisplay in interface EffectiveRecipient

getSalutationForOutput

@Nullable
public @Nullable String getSalutationForOutput()

Description copied from interface: EffectiveRecipient

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

Specified by:

getSalutationForOutput in interface EffectiveRecipient

setSalutationForOutput

public void setSalutationForOutput(String salutationForOutput)

Specified by:

setSalutationForOutput in interface EffectiveRecipient

getAddressForOutput

@Nullable
public @Nullable String getAddressForOutput()

Description copied from interface: EffectiveRecipient

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

Specified by:

getAddressForOutput in interface EffectiveRecipient

setAddressForOutput

public void setAddressForOutput(String addressForOutput)

Specified by:

setAddressForOutput in interface EffectiveRecipient

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getClientRepresentation

public EffectiveRecipient.ClientRepresentation getClientRepresentation()

Description copied from interface: EffectiveRecipient

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

Specified by:

getClientRepresentation in interface EffectiveRecipient

Returns:

the simple EffectiveRecipient representation

getConcernedRecipient

public ConcernedRecipient getConcernedRecipient()

Specified by:

getConcernedRecipient in interface EffectiveRecipient