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

java.lang.Object
  extended by org.kuali.rice.core.api.mo.AbstractDataTransferObject
      extended by org.kuali.rice.kim.api.identity.type.EntityTypeContactInfo
All Implemented Interfaces:
Serializable, Inactivatable, GloballyUnique, Versioned, ModelObjectBasic, ModelObjectComplete, EntityTypeContactInfoContract

public final class EntityTypeContactInfo
extends AbstractDataTransferObject
implements EntityTypeContactInfoContract

See Also:
Serialized Form

Nested Class Summary
static class EntityTypeContactInfo.Builder
          A builder which can be used to construct EntityTypeContactInfo instances.
 
Method Summary
 List<EntityAddress> getAddresses()
          Gets this EntityTypeContactInfoContract's List of EntityAddressS.
 EntityAddressContract getDefaultAddress()
          Returns the default address record for the identity.
 EntityEmail getDefaultEmailAddress()
          Returns the default email record for the identity.
 EntityPhoneContract getDefaultPhoneNumber()
          Returns the default phone record for the identity.
 List<EntityEmail> getEmailAddresses()
          Gets this EntityTypeContactInfoContract's List of EntityEmailContractS.
 String getEntityId()
          Gets the id of the parent identity object.
 CodedAttributeContract 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> 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.
 
Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject
afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

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 CodedAttributeContract 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> 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> 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> 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 EntityAddressContract 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 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 EntityPhoneContract 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.


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