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

Interface EntityResidencyContract

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.Versioned

All Known Implementing Classes:

EntityResidency, EntityResidency.Builder

public interface EntityResidencyContract
extends org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Identifiable

residency info for a KIM identity

Author:

Kuali Rice Team (kuali-rice@googlegroups.com)

Method Summary

Modifier and Type	Method	Description
String	getDeterminationMethod()	Gets this EntityResidencyContract's determination method.
String	getEntityId()	Gets this EntityResidencyContract's identity id.
String	getInState()	Gets the state this EntityResidencyContract is in.

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.Versioned

getVersionNumber

Method Details

getEntityId

String getEntityId()

Gets this EntityResidencyContract's identity id.

Returns:

the identity id for this EntityResidencyContract, or null if none has been assigned.

getDeterminationMethod

String getDeterminationMethod()

Gets this EntityResidencyContract's determination method.

Returns:

the determination method for this EntityResidencyContract, or null if none has been assigned.

getInState

String getInState()

Gets the state this EntityResidencyContract is in.

Returns:

the state this EntityResidencyContract is in, or null if none has been assigned.