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

Interface EntityCitizenshipContract

All Superinterfaces:

org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Versioned

All Known Implementing Classes:

EntityCitizenship, EntityCitizenship.Builder

public interface EntityCitizenshipContract
extends org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Identifiable

This contract represents the citizenship information associated with an Entity.

Author:

Kuali Rice Team (rice.collab@kuali.org)

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.
org.joda.time.DateTime	getStartDate()	Gets this EntityCitizenshipContract's start date.
CodedAttributeContract	getStatus()	Gets this EntityCitizenshipContract's citizenship status object.

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Methods inherited from interface org.kuali.rice.core.api.mo.common.Identifiable

getId

Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable

isActive

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Method Details

getEntityId

String getEntityId()

Gets this id of the parent identity object.

Returns:

the identity id for this EntityCitizenshipContract

getStatus

CodedAttributeContract getStatus()

Gets this EntityCitizenshipContract's citizenship status object.

Returns:

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

getCountryCode

String getCountryCode()

Gets this EntityCitizenshipContract's country code.

Returns:

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

getStartDate

org.joda.time.DateTime getStartDate()

Gets this EntityCitizenshipContract's start date.

Returns:

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

getEndDate

org.joda.time.DateTime getEndDate()

Gets this EntityCitizenshipContract's end date.

Returns:

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