org.kuali.rice.kim.api.identity.type
Class EntityTypeContactInfo.Builder

java.lang.Object
  extended by org.kuali.rice.kim.api.identity.type.EntityTypeContactInfo.Builder
All Implemented Interfaces:
Serializable, Inactivatable, GloballyUnique, Versioned, ModelBuilder, EntityTypeContactInfoContract
Enclosing class:
EntityTypeContactInfo

public static final class EntityTypeContactInfo.Builder
extends Object
implements Serializable, ModelBuilder, EntityTypeContactInfoContract

A builder which can be used to construct EntityTypeContactInfo instances. Enforces the constraints of the EntityTypeContactInfoContract.

See Also:
Serialized Form

Method Summary
 EntityTypeContactInfo build()
          Returns an instance of the object being built by this builder based on the current state of the builder.
static EntityTypeContactInfo.Builder create(EntityTypeContactInfoContract contract)
           
static EntityTypeContactInfo.Builder create(String entityId, String entityTypeCode)
           
 List<EntityAddress.Builder> getAddresses()
          Gets this EntityTypeContactInfoContract's List of EntityAddressS.
 EntityAddress.Builder getDefaultAddress()
          Returns the default address record for the identity.
 EntityEmail.Builder getDefaultEmailAddress()
          Returns the default email record for the identity.
 EntityPhone.Builder getDefaultPhoneNumber()
          Returns the default phone record for the identity.
 List<EntityEmail.Builder> getEmailAddresses()
          Gets this EntityTypeContactInfoContract's List of EntityEmailContractS.
 String getEntityId()
          Gets the id of the parent identity object.
 CodedAttribute.Builder getEntityType()
          Gets this identity Type of the EntityTypeContactInfoContract's object.
 String getEntityTypeCode()
          Gets this entityTypeCode of the EntityAddressContract's object.
 String getObjectId()
          Return the globally unique object id of this object.
 List<EntityPhone.Builder> getPhoneNumbers()
          Gets this EntityTypeContactInfoContract's List of EntityPhoneS.
 Long getVersionNumber()
          Returns the version number for this object.
 boolean isActive()
          The active indicator for an object.
 void setActive(boolean active)
           
 void setAddresses(List addresses)
           
 void setEmailAddresses(List emailAddresses)
           
 void setEntityId(String entityId)
           
 void setEntityType(CodedAttribute.Builder entityType)
           
 void setEntityTypeCode(String entityTypeCode)
           
 void setObjectId(String objectId)
           
 void setPhoneNumbers(List phoneNumbers)
           
 void setVersionNumber(Long versionNumber)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

create

public static EntityTypeContactInfo.Builder create(String entityId,
                                                   String entityTypeCode)

create

public static EntityTypeContactInfo.Builder create(EntityTypeContactInfoContract contract)

build

public EntityTypeContactInfo build()
Description copied from interface: ModelBuilder
Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;

Specified by:
build in interface ModelBuilder
Returns:
an instance of the object being built by this builder, should never return null

getEntityId

public String getEntityId()
Description copied from interface: EntityTypeContactInfoContract
Gets the id of the parent identity object.

Specified by:
getEntityId in interface EntityTypeContactInfoContract
Returns:
the identity id for this EntityAddressContract

getEntityTypeCode

public String getEntityTypeCode()
Description copied from interface: EntityTypeContactInfoContract
Gets this entityTypeCode of the EntityAddressContract's object.

Specified by:
getEntityTypeCode in interface EntityTypeContactInfoContract
Returns:
the identity type code for this EntityAddressContract

getEntityType

public CodedAttribute.Builder getEntityType()
Description copied from interface: EntityTypeContactInfoContract
Gets this identity Type of the EntityTypeContactInfoContract's object.

Specified by:
getEntityType in interface EntityTypeContactInfoContract
Returns:
the identity type for this EntityTypeContactInfoContract

getAddresses

public List<EntityAddress.Builder> getAddresses()
Description copied from interface: EntityTypeContactInfoContract
Gets this EntityTypeContactInfoContract's List of EntityAddressS.

Specified by:
getAddresses in interface EntityTypeContactInfoContract
Returns:
the List of EntityAddressContractS for this EntityTypeContactInfoContract. The returned List will never be null, an empty List will be assigned and returned if needed.

getEmailAddresses

public List<EntityEmail.Builder> getEmailAddresses()
Description copied from interface: EntityTypeContactInfoContract
Gets this EntityTypeContactInfoContract's List of EntityEmailContractS.

Specified by:
getEmailAddresses in interface EntityTypeContactInfoContract
Returns:
the List of EntityEmailContractS for this EntityTypeContactInfoContract. The returned List will never be null, an empty List will be assigned and returned if needed.

getPhoneNumbers

public List<EntityPhone.Builder> getPhoneNumbers()
Description copied from interface: EntityTypeContactInfoContract
Gets this EntityTypeContactInfoContract's List of EntityPhoneS.

Specified by:
getPhoneNumbers in interface EntityTypeContactInfoContract
Returns:
the List of EntityPhoneContractS for this EntityTypeContactInfoContract. The returned List will never be null, an empty List will be assigned and returned if needed.

getDefaultAddress

public EntityAddress.Builder getDefaultAddress()
Description copied from interface: EntityTypeContactInfoContract
Returns the default address record for the identity. If no default is defined, then it returns the first one found. If none are defined, it returns null.

Specified by:
getDefaultAddress in interface EntityTypeContactInfoContract

getDefaultEmailAddress

public EntityEmail.Builder getDefaultEmailAddress()
Description copied from interface: EntityTypeContactInfoContract
Returns the default email record for the identity. If no default is defined, then it returns the first one found. If none are defined, it returns null.

Specified by:
getDefaultEmailAddress in interface EntityTypeContactInfoContract

getDefaultPhoneNumber

public EntityPhone.Builder getDefaultPhoneNumber()
Description copied from interface: EntityTypeContactInfoContract
Returns the default phone record for the identity. If no default is defined, then it returns the first one found. If none are defined, it returns null.

Specified by:
getDefaultPhoneNumber in interface EntityTypeContactInfoContract

getVersionNumber

public Long getVersionNumber()
Description copied from interface: Versioned
Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.

Specified by:
getVersionNumber in interface Versioned
Returns:
the version number, or null if one has not been assigned yet

getObjectId

public String getObjectId()
Description copied from interface: GloballyUnique
Return the globally unique object id of this object. In general, this value should only be null if the object has not yet been stored to a persistent data store.

Specified by:
getObjectId in interface GloballyUnique
Returns:
the objectId of this object, or null if it has not been set yet

isActive

public boolean isActive()
Description copied from interface: Inactivatable
The active indicator for an object.

Specified by:
isActive in interface Inactivatable
Returns:
true if active false if not.

setEntityId

public void setEntityId(String entityId)

setEntityTypeCode

public void setEntityTypeCode(String entityTypeCode)

setEntityType

public void setEntityType(CodedAttribute.Builder entityType)

setAddresses

public void setAddresses(List addresses)

setEmailAddresses

public void setEmailAddresses(List emailAddresses)

setPhoneNumbers

public void setPhoneNumbers(List phoneNumbers)

setVersionNumber

public void setVersionNumber(Long versionNumber)

setObjectId

public void setObjectId(String objectId)

setActive

public void setActive(boolean active)


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.