Package org.kuali.rice.kim.api.identity.citizenship

Class EntityCitizenship

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.rice.kim.api.identity.citizenship.EntityCitizenship

All Implemented Interfaces:

Serializable, Inactivatable, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, EntityCitizenshipContract

public final class EntityCitizenship
extends AbstractDataTransferObject
implements EntityCitizenshipContract

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EntityCitizenship.Builder	A builder which can be used to construct EntityCitizenship instances.

Method Summary

Modifier and Type	Method	Description
String	getCountryCode()	Gets this EntityCitizenshipContract's country code.
org.joda.time.DateTime	getEndDate()	Gets this EntityCitizenshipContract's end date.
String	getEntityId()	Gets this id of the parent identity object.
String	getId()
String	getObjectId()
org.joda.time.DateTime	getStartDate()	Gets this EntityCitizenshipContract's start date.
CodedAttribute	getStatus()	Gets this EntityCitizenshipContract's citizenship status object.
Long	getVersionNumber()
boolean	isActive()

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 Details

getEntityId

public String getEntityId()

Description copied from interface: EntityCitizenshipContract

Gets this id of the parent identity object.

Specified by:

getEntityId in interface EntityCitizenshipContract

Returns:

the identity id for this EntityCitizenshipContract

getStatus

public CodedAttribute getStatus()

Description copied from interface: EntityCitizenshipContract

Gets this EntityCitizenshipContract's citizenship status object.

Specified by:

getStatus in interface EntityCitizenshipContract

Returns:

the Type object of citizenship status for this EntityCitizenshipContract, or null if none has been assigned.

getCountryCode

public String getCountryCode()

Description copied from interface: EntityCitizenshipContract

Gets this EntityCitizenshipContract's country code.

Specified by:

getCountryCode in interface EntityCitizenshipContract

Returns:

the country code for this EntityCitizenshipContract, or null if none has been assigned.

getStartDate

public org.joda.time.DateTime getStartDate()

Description copied from interface: EntityCitizenshipContract

Gets this EntityCitizenshipContract's start date.

Specified by:

getStartDate in interface EntityCitizenshipContract

Returns:

the start date for this EntityCitizenshipContract, or null if none has been assigned.

getEndDate

public org.joda.time.DateTime getEndDate()

Description copied from interface: EntityCitizenshipContract

Gets this EntityCitizenshipContract's end date.

Specified by:

getEndDate in interface EntityCitizenshipContract

Returns:

the end date for this EntityCitizenshipContract, or null if none has been assigned.

getVersionNumber

public Long getVersionNumber()

Specified by:

getVersionNumber in interface Versioned

getObjectId

public String getObjectId()

Specified by:

getObjectId in interface GloballyUnique

isActive

public boolean isActive()

Specified by:

isActive in interface Inactivatable

getId

public String getId()

Specified by:

getId in interface Identifiable