com.whitepages.proapi.data.entity

Class LocationProxy

java.lang.Object

com.whitepages.proapi.data.entity.EntityProxy

com.whitepages.proapi.data.entity.LocationProxy

All Implemented Interfaces:

Entity, Location

public class LocationProxy
extends EntityProxy
implements Location

Strongly typed EntityProxy for Location entities.

See Also:

EntityProxy, Location, Entity

Nested Class Summary

Nested classes/interfaces inherited from interface com.whitepages.proapi.data.entity.Location

Location.AddressType, Location.AddressUsage, Location.BoxType, Location.DeliveryPoint, Location.LatLong, Location.LocationType, Location.NotReceivingMailReason

Constructor Summary

Constructors

Constructor and Description
LocationProxy(EntityId entityId, Client client)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAddress()
Location.AddressType	getAddressType()
java.lang.String	getAptNumber()
java.lang.String	getAptType()
java.lang.String	getBoxNumber()
Location.BoxType	getBoxType()
java.lang.String	getCity()
java.lang.String	getCountryCode()
java.lang.Boolean	getDeliverable()
Location.DeliveryPoint	getDeliveryPoint()
java.lang.String	getHouse()
Location.LatLong	getLatLong()
Location.NotReceivingMailReason	getNotReceivingMailReason()
java.lang.String	getPostalCode()
java.lang.String	getPostDir()
java.lang.String	getPreDir()
java.lang.Boolean	getReceivingMail()
java.lang.String	getStandardAddressLine1()
java.lang.String	getStandardAddressLine2()
java.lang.String	getStandardAddressLocation()
java.lang.String	getStateCode()
java.lang.String	getStreetName()
java.lang.String	getStreetType()
Location.LocationType	getType()
Location.AddressUsage	getUsage()
TimePeriod	getValidFor()
java.lang.String	getZip4()
void	load() Causes this instance to load its data by contacting the remote service and requesting information.

Methods inherited from class com.whitepages.proapi.data.entity.EntityProxy

getAssociations, getBusinessAssociations, getBusinesses, getEntities, getId, getLocationAssociations, getLocations, getName, getPeople, getPersonAssociations, getPhoneAssociations, getPhones, isLoaded, isProxy

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.whitepages.proapi.data.entity.Entity

getAssociations, getBusinessAssociations, getBusinesses, getEntities, getId, getLocationAssociations, getLocations, getName, getPeople, getPersonAssociations, getPhoneAssociations, getPhones, isLoaded, isProxy

Constructor Detail

LocationProxy

public LocationProxy(EntityId entityId,
             Client client)

Method Detail

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

Specified by:

load in class EntityProxy

Throws:

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

See Also:

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

getType

public Location.LocationType getType()

Specified by:

getType in interface Location

getAddress

public java.lang.String getAddress()

Specified by:

getAddress in interface Location

getStandardAddressLine1

public java.lang.String getStandardAddressLine1()

Specified by:

getStandardAddressLine1 in interface Location

getStandardAddressLine2

public java.lang.String getStandardAddressLine2()

Specified by:

getStandardAddressLine2 in interface Location

getStandardAddressLocation

public java.lang.String getStandardAddressLocation()

Specified by:

getStandardAddressLocation in interface Location

getCity

public java.lang.String getCity()

Specified by:

getCity in interface Location

getPostalCode

public java.lang.String getPostalCode()

Specified by:

getPostalCode in interface Location

getStateCode

public java.lang.String getStateCode()

Specified by:

getStateCode in interface Location

getCountryCode

public java.lang.String getCountryCode()

Specified by:

getCountryCode in interface Location

getAptType

public java.lang.String getAptType()

Specified by:

getAptType in interface Location

getZip4

public java.lang.String getZip4()

Specified by:

getZip4 in interface Location

getHouse

public java.lang.String getHouse()

Specified by:

getHouse in interface Location

getStreetName

public java.lang.String getStreetName()

Specified by:

getStreetName in interface Location

getStreetType

public java.lang.String getStreetType()

Specified by:

getStreetType in interface Location

getPreDir

public java.lang.String getPreDir()

Specified by:

getPreDir in interface Location

getPostDir

public java.lang.String getPostDir()

Specified by:

getPostDir in interface Location

getAptNumber

public java.lang.String getAptNumber()

Specified by:

getAptNumber in interface Location

getBoxNumber

public java.lang.String getBoxNumber()

Specified by:

getBoxNumber in interface Location

getValidFor

public TimePeriod getValidFor()

Specified by:

getValidFor in interface Location

getReceivingMail

public java.lang.Boolean getReceivingMail()

Specified by:

getReceivingMail in interface Location

getNotReceivingMailReason

public Location.NotReceivingMailReason getNotReceivingMailReason()

Specified by:

getNotReceivingMailReason in interface Location

getUsage

public Location.AddressUsage getUsage()

Specified by:

getUsage in interface Location

getDeliveryPoint

public Location.DeliveryPoint getDeliveryPoint()

Specified by:

getDeliveryPoint in interface Location

getBoxType

public Location.BoxType getBoxType()

Specified by:

getBoxType in interface Location

getAddressType

public Location.AddressType getAddressType()

Specified by:

getAddressType in interface Location

getLatLong

public Location.LatLong getLatLong()

Specified by:

getLatLong in interface Location

getDeliverable

public java.lang.Boolean getDeliverable()

Specified by:

getDeliverable in interface Location