com.whitepages.proapi.data.association

Class Association

java.lang.Object

com.whitepages.proapi.data.association.Association

Direct Known Subclasses:

LegalEntityAssociation, LocationAssociation, PhoneAssociation

public abstract class Association
extends java.lang.Object

The root interface for all Associations (e.g. PersonAssociation, BusinessAssociation, PhoneAssociation, and LocationAssociation).

The Whitepages API presents its data in a directed graph form, whereby:

• Each node is an Entity, and
• Each edge is an Association.

Entities contain data intrinsic to the entity, whereas associations contain data pertaining to the relationship between its source and destination entities

Associations are a directed edge from a source entity node to a destination entity node. Since traversal starts from the source entity, there is only one accessor on the Assocation instance, which leads to the destination entity.

See Also:

Entity, PersonAssociation, BusinessAssociation, PhoneAssociation, LocationAssociation

Constructor Summary

Constructors

Constructor and Description
Association(EntityId entityId, ResponseDictionary dictionary)
Association(EntityId entityId, ResponseDictionary dictionary, TimePeriod validFor, java.lang.Boolean historical, java.util.Date contactCreationDate)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	getContactCreationDate()
abstract Entity	getEntity()
EntityId	getEntityId() Returns the ID of the associated entity.
abstract EntityId.EntityType	getEntityIdType()
java.lang.Boolean	getHistorical()
TimePeriod	getValidFor()
void	setContactCreationDate(java.util.Date contactCreationDate)
void	setHistorical(java.lang.Boolean historical)
void	setValidFor(TimePeriod validFor)

Methods inherited from class java.lang.Object

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

Constructor Detail

Association

public Association(EntityId entityId,
           ResponseDictionary dictionary)

Association

public Association(EntityId entityId,
           ResponseDictionary dictionary,
           TimePeriod validFor,
           java.lang.Boolean historical,
           java.util.Date contactCreationDate)

Method Detail

getEntityId

public EntityId getEntityId()

Returns the ID of the associated entity.

getEntity

public abstract Entity getEntity()

Returns the associated entity in a way that is generic across all Association types; for strongly typed accessors, see PersonAssociation.getPerson(), BusinessAssociation.getBusiness(), PhoneAssociation.getPhone(), and LocationAssociation.getLocation().

Returns:

See Also:

PersonAssociation.getPerson(), BusinessAssociation.getBusiness(), PhoneAssociation.getPhone(), LocationAssociation.getLocation()

getEntityIdType

public abstract EntityId.EntityType getEntityIdType()

getValidFor

public TimePeriod getValidFor()

setValidFor

public void setValidFor(TimePeriod validFor)

getHistorical

public java.lang.Boolean getHistorical()

setHistorical

public void setHistorical(java.lang.Boolean historical)

getContactCreationDate

public java.util.Date getContactCreationDate()

setContactCreationDate

public void setContactCreationDate(java.util.Date contactCreationDate)