com.whitepages.proapi.data.entity

Class EntityProxy

java.lang.Object

com.whitepages.proapi.data.entity.EntityProxy

All Implemented Interfaces:

Entity

Direct Known Subclasses:

BusinessProxy, LocationProxy, PersonProxy, PhoneProxy

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

The complete entity graph, traversed to its full extent, would be incredibly large, thus, in practice, only a subset of this graph is presented in the Response. As a result, in some cases you may encounter associations whose nodes are not available to you. When this occurs, an appropriate EntityProxy instance is put into its place. To test if an entity is a proxy, use the isProxy() method.

Entity proxies satisfy the appropriate entity interface, returning null for all the values—acting as if the values were masked from you. The exception to this rule is the ID of the associated entity, which is always present on a proxy value.

To load an entity, call the load() method. This method will make a call to the remote service, fetching information for the associated entity ID. To test if a value has been loaded, the isLoaded() method may be used.

See Also:

isProxy(), isLoaded(), load(), Entity

Constructor Summary

Constructors

Constructor and Description
EntityProxy(EntityId entityId, Client client)

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()
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.
abstract void	load() Causes this instance to load its data by contacting the remote service and requesting information.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityProxy

public EntityProxy(EntityId entityId,
           Client client)

Method Detail

load

public abstract 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

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

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

getId

public EntityId getId()

Specified by:

getId in interface Entity

getName

public 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.

getPersonAssociations

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

Specified by:

getPersonAssociations in interface Entity

getBusinessAssociations

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

Specified by:

getBusinessAssociations in interface Entity

getLocationAssociations

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

Specified by:

getLocationAssociations in interface Entity

getPhoneAssociations

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

Specified by:

getPhoneAssociations in interface Entity

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.