com.whitepages.proapi.data.entity

Class EntityImpl

java.lang.Object

com.whitepages.proapi.data.entity.EntityImpl

All Implemented Interfaces:

Entity

Direct Known Subclasses:

BusinessImpl, LocationImpl, PersonImpl, PhoneImpl

public abstract class EntityImpl
extends java.lang.Object
implements Entity

Abstract class for implementation of common behaviors between all Entity types.

See Also:

Entity

Constructor Summary

Constructors

Constructor and Description
EntityImpl()
EntityImpl(EntityId id)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<Association>	getAssociations() A convenience method for getting the concatenation of the association lists.
java.util.List<BusinessAssociation>	getBusinessAssociations()
java.util.List<Business>	getBusinesses()
java.util.List<Entity>	getEntities() A convenience method for getting the concatenation of the entity lists.
EntityId	getId()
java.util.List<LocationAssociation>	getLocationAssociations()
java.util.List<Location>	getLocations()
abstract java.lang.String	getName() A standardized method for getting the primary, human readable, formatted String version of this entity.
java.util.List<Person>	getPeople()
java.util.List<PersonAssociation>	getPersonAssociations()
java.util.List<PhoneAssociation>	getPhoneAssociations()
java.util.List<Phone>	getPhones()
boolean	isLoaded() If the called on a proxy, return true only if the backing entity has been fetched.
boolean	isProxy() Returns true if this entity instance is a proxy instance.
void	load() Causes this instance to load its data by contacting the remote service and requesting information.
void	setBusinessAssociations(java.util.List<BusinessAssociation> businessAssociations)
void	setId(EntityId id)
void	setLocationAssociations(java.util.List<LocationAssociation> locationAssociations)
void	setPersonAssociations(java.util.List<PersonAssociation> personAssociations)
void	setPhoneAssociations(java.util.List<PhoneAssociation> phoneAssociations)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EntityImpl

public EntityImpl()

EntityImpl

public EntityImpl(EntityId id)

Method Detail

getId

public EntityId getId()

Specified by:

getId in interface Entity

setId

public void setId(EntityId id)

getPersonAssociations

public java.util.List<PersonAssociation> getPersonAssociations()

Specified by:

getPersonAssociations in interface Entity

setPersonAssociations

public void setPersonAssociations(java.util.List<PersonAssociation> personAssociations)

getBusinessAssociations

public java.util.List<BusinessAssociation> getBusinessAssociations()

Specified by:

getBusinessAssociations in interface Entity

setBusinessAssociations

public void setBusinessAssociations(java.util.List<BusinessAssociation> businessAssociations)

getLocationAssociations

public java.util.List<LocationAssociation> getLocationAssociations()

Specified by:

getLocationAssociations in interface Entity

setLocationAssociations

public void setLocationAssociations(java.util.List<LocationAssociation> locationAssociations)

getPhoneAssociations

public java.util.List<PhoneAssociation> getPhoneAssociations()

Specified by:

getPhoneAssociations in interface Entity

setPhoneAssociations

public void setPhoneAssociations(java.util.List<PhoneAssociation> phoneAssociations)

getAssociations

public java.util.List<Association> getAssociations()

Description copied from interface: Entity

A convenience method for getting the concatenation of the association lists.

Specified by:

getAssociations in interface Entity

Returns:

Concatenated list of all associations.

getPeople

public java.util.List<Person> getPeople()

Specified by:

getPeople in interface Entity

getBusinesses

public java.util.List<Business> getBusinesses()

Specified by:

getBusinesses in interface Entity

getLocations

public java.util.List<Location> getLocations()

Specified by:

getLocations in interface Entity

getPhones

public java.util.List<Phone> getPhones()

Specified by:

getPhones in interface Entity

getEntities

public java.util.List<Entity> getEntities()

Description copied from interface: Entity

A convenience method for getting the concatenation of the entity lists.

Specified by:

getEntities in interface Entity

Returns:

Concatenated list of all entities associated with this entity.

getName

public abstract java.lang.String getName()

Description copied from interface: Entity

A standardized method for getting the primary, human readable, formatted String version of this entity.

Specified by:

getName in interface Entity

Returns:

The human formatted string.

isProxy

public boolean isProxy()

Description copied from interface: Entity

Returns true if this entity instance is a proxy instance.

Specified by:

isProxy in interface Entity

Returns:

true if this entity instance is a proxy instance.

See Also:

Entity.isLoaded(), Entity.load(), EntityProxy

isLoaded

public boolean isLoaded()

Description copied from interface: Entity

If the called on a proxy, return true only if the backing entity has been fetched. If called on a concrete entity, then always return true.

Specified by:

isLoaded in interface Entity

Returns:

load status for this entity.

See Also:

Entity.isProxy(), Entity.load(), EntityProxy

load

public void load()
          throws FindException

Description copied from interface: Entity

Causes this instance to load its data by contacting the remote service and requesting information. Once loaded, subsequent calls to this method have no effect.

This method is useful for proxy entities found at the edge of the graph.

Specified by:

load in interface Entity

Throws:

FindException - If the lookup fails before it is able to generate a Response object.

See Also:

Entity.isProxy(), Entity.isLoaded(), EntityProxy