org.kuali.rice.kim.api.identity

Interface IdentityService

public interface IdentityService

Created by sheiksalahudeenm on 5/5/15.

Method Summary

Methods

Modifier and Type	Method and Description
org.kuali.rice.kim.api.identity.address.EntityAddress	addAddressToEntity(org.kuali.rice.kim.api.identity.address.EntityAddress address) This will create a EntityAddress exactly like the address passed in.
org.kuali.rice.kim.api.identity.affiliation.EntityAffiliation	addAffiliationToEntity(org.kuali.rice.kim.api.identity.affiliation.EntityAffiliation affiliation) This will create a EntityAffiliation exactly like the affiliation passed in.
org.kuali.rice.kim.api.identity.personal.EntityBioDemographics	addBioDemographicsToEntity(org.kuali.rice.kim.api.identity.personal.EntityBioDemographics bioDemographics) This will create a EntityBioDemographics exactly like the bioDemographics passed in.
org.kuali.rice.kim.api.identity.citizenship.EntityCitizenship	addCitizenshipToEntity(org.kuali.rice.kim.api.identity.citizenship.EntityCitizenship citizenship) This will create a EntityCitizenship exactly like the citizenship passed in.
org.kuali.rice.kim.api.identity.email.EntityEmail	addEmailToEntity(org.kuali.rice.kim.api.identity.email.EntityEmail email) This will create a EntityEmail exactly like the email passed in.
org.kuali.rice.kim.api.identity.employment.EntityEmployment	addEmploymentToEntity(org.kuali.rice.kim.api.identity.employment.EntityEmployment employment) This will create a EntityEmployment exactly like the employment passed in.
org.kuali.rice.kim.api.identity.type.EntityTypeContactInfo	addEntityTypeContactInfoToEntity(org.kuali.rice.kim.api.identity.type.EntityTypeContactInfo entityTypeContactInfo) This will create a EntityTypeContactInfo exactly like the entityTypeContactInfo passed in.
org.kuali.rice.kim.api.identity.personal.EntityEthnicity	addEthnicityToEntity(org.kuali.rice.kim.api.identity.personal.EntityEthnicity ethnicity) This will create a EntityEthnicity exactly like the ethnicity passed in.
org.kuali.rice.kim.api.identity.external.EntityExternalIdentifier	addExternalIdentifierToEntity(org.kuali.rice.kim.api.identity.external.EntityExternalIdentifier externalId) This will create a EntityExternalIdentifier exactly like the externalId passed in.
org.kuali.rice.kim.api.identity.name.EntityName	addNameToEntity(org.kuali.rice.kim.api.identity.name.EntityName name) This will create a EntityName exactly like the name passed in.
org.kuali.rice.kim.api.identity.phone.EntityPhone	addPhoneToEntity(org.kuali.rice.kim.api.identity.phone.EntityPhone phone) This will create a EntityPhone exactly like the phone passed in.
org.kuali.rice.kim.api.identity.principal.Principal	addPrincipalToEntity(org.kuali.rice.kim.api.identity.principal.Principal principal) This will create a Principal exactly like the principal passed in.
org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences	addPrivacyPreferencesToEntity(org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences privacyPreferences) This will create a EntityPrivacyPreferences exactly like the privacyPreferences passed in.
org.kuali.rice.kim.api.identity.residency.EntityResidency	addResidencyToEntity(org.kuali.rice.kim.api.identity.residency.EntityResidency residency) This will create a EntityResidency exactly like the residency passed in.
org.kuali.rice.kim.api.identity.visa.EntityVisa	addVisaToEntity(org.kuali.rice.kim.api.identity.visa.EntityVisa visa) This will create a EntityVisa exactly like the visa passed in.
org.kuali.rice.kim.api.identity.entity.Entity	createEntity(org.kuali.rice.kim.api.identity.entity.Entity entity) This will create a Entity exactly like the entity passed in.
List<org.kuali.rice.kim.api.identity.CodedAttribute>	findAllAddressTypes() Finds all EntityAddressTypes
List<org.kuali.rice.kim.api.identity.affiliation.EntityAffiliationType>	findAllAffiliationTypes() Finds all EntityAffiliationTypes
List<org.kuali.rice.kim.api.identity.CodedAttribute>	findAllCitizenshipStatuses() Finds all EntityCitizenshipStatuses
List<org.kuali.rice.kim.api.identity.CodedAttribute>	findAllEmailTypes() Finds all EntityEmailTypes
List<org.kuali.rice.kim.api.identity.CodedAttribute>	findAllEmploymentStatuses() Finds all EntityEmploymentStatuses
List<org.kuali.rice.kim.api.identity.CodedAttribute>	findAllEmploymentTypes() Finds all EntityEmploymentTypes
List<org.kuali.rice.kim.api.identity.CodedAttribute>	findAllEntityTypes() Finds all EntityTypes
List<org.kuali.rice.kim.api.identity.external.EntityExternalIdentifierType>	findAllExternalIdendtifierTypes() Finds all ExternalIdentifierTypes
List<org.kuali.rice.kim.api.identity.CodedAttribute>	findAllNameTypes() Finds all EntityNameTypes
List<org.kuali.rice.kim.api.identity.CodedAttribute>	findAllPhoneTypes() Finds all EntityPhoneTypes
org.kuali.rice.kim.api.identity.entity.EntityQueryResults	findEntities(org.kuali.rice.core.api.criteria.QueryByCriteria query) This method finds Entities based on a query criteria.
org.kuali.rice.kim.api.identity.entity.EntityDefaultQueryResults	findEntityDefaults(org.kuali.rice.core.api.criteria.QueryByCriteria query) This method finds EntityDefault data based on a query criteria.
org.kuali.rice.kim.api.identity.principal.PrincipalQueryResults	findPrincipals(org.kuali.rice.core.api.criteria.QueryByCriteria query) This method finds Principals based on a query criteria.
org.kuali.rice.kim.api.identity.CodedAttribute	getAddressType(String code) Gets the CodedAttribute for a given EntityAddressType code.
org.kuali.rice.kim.api.identity.affiliation.EntityAffiliationType	getAffiliationType(String code) Gets the EntityAffiliationType for a given EntityAffiliationType code.
org.kuali.rice.kim.api.identity.CodedAttribute	getCitizenshipStatus(String code) Gets the CodedAttribute for a given EntityCitizenship status code.
org.kuali.rice.kim.api.identity.principal.EntityNamePrincipalName	getDefaultNamesForPrincipalId(String principalId) This returns the display name information for the given principal without loading the full person object.
org.kuali.rice.kim.api.identity.CodedAttribute	getEmailType(String code) Gets the CodedAttribute for a given EntityEmail type code.
org.kuali.rice.kim.api.identity.CodedAttribute	getEmploymentStatus(String code) Gets the CodedAttribute for a given EntityEmployment status code.
org.kuali.rice.kim.api.identity.CodedAttribute	getEmploymentType(String code) Gets the CodedAttribute for a given EntityEmployment type code.
org.kuali.rice.kim.api.identity.entity.Entity	getEntity(String id) Gets a Entity from an id.
org.kuali.rice.kim.api.identity.entity.Entity	getEntityByEmployeeId(String employeeId) Gets a Entity from a employeeId.
org.kuali.rice.kim.api.identity.entity.Entity	getEntityByPrincipalId(String principalId) Gets a Entity from a principalId.
org.kuali.rice.kim.api.identity.entity.Entity	getEntityByPrincipalName(String principalName) Gets a Entity from a principalName.
org.kuali.rice.kim.api.identity.entity.EntityDefault	getEntityDefault(String id) Gets a EntityDefault from an id.
org.kuali.rice.kim.api.identity.entity.EntityDefault	getEntityDefaultByEmployeeId(String employeeId) Gets a EntityDefault from an employeeId.
org.kuali.rice.kim.api.identity.entity.EntityDefault	getEntityDefaultByPrincipalId(String principalId) Gets a EntityDefault from an principalId.
org.kuali.rice.kim.api.identity.entity.EntityDefault	getEntityDefaultByPrincipalName(String principalName) Gets a EntityDefault from an principalName.
org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences	getEntityPrivacyPreferences(String id) Gets a EntityPrivacyPreferences for a given id.
org.kuali.rice.kim.api.identity.CodedAttribute	getEntityType(String code) Gets the CodedAttribute for a given EntityType code.
org.kuali.rice.kim.api.identity.external.EntityExternalIdentifierType	getExternalIdentifierType(String code) Gets the EntityExternalIdentifierType for a given type code.
org.kuali.rice.kim.api.identity.CodedAttribute	getNameType(String code) Gets the CodedAttribute for a given EntityName type code.
org.kuali.rice.kim.api.identity.CodedAttribute	getPhoneType(String code) Gets the CodedAttribute for a given EntityPhone type code.
org.kuali.rice.kim.api.identity.principal.Principal	getPrincipal(String principalId) Gets a Principal from an principalId.
org.kuali.rice.kim.api.identity.principal.Principal	getPrincipalByPrincipalName(String principalName) Gets a Principal from an principalName.
org.kuali.rice.kim.api.identity.principal.Principal	getPrincipalByPrincipalNameAndPassword(String principalName, String password) Gets a Principal from an principalName and password.
List<org.kuali.rice.kim.api.identity.principal.Principal>	getPrincipals(List<String> principalIds) Gets a list of Principal from a string list of principalId.
List<org.kuali.rice.kim.api.identity.principal.Principal>	getPrincipalsByEmployeeId(String employeeId) Gets a list of Principal from an employeeId
List<org.kuali.rice.kim.api.identity.principal.Principal>	getPrincipalsByEntityId(String entityId) Gets a list of Principal from an entityId.
org.kuali.rice.kim.api.identity.address.EntityAddress	inactivateAddress(String id) This will inactivate a EntityAddress with the id passed in.
org.kuali.rice.kim.api.identity.affiliation.EntityAffiliation	inactivateAffiliation(String id) This will inactivate a EntityAffiliation with the id passed in.
org.kuali.rice.kim.api.identity.citizenship.EntityCitizenship	inactivateCitizenship(String id) This will inactivate a EntityCitizenship with the unique id passed in.
org.kuali.rice.kim.api.identity.email.EntityEmail	inactivateEmail(String id) This will inactivate the EntityEmail with the passed in id.
org.kuali.rice.kim.api.identity.employment.EntityEmployment	inactivateEmployment(String id) This will inactivate a EntityEmployment with the passed in id.
org.kuali.rice.kim.api.identity.entity.Entity	inactivateEntity(String id) This will inactivate a Entity.
org.kuali.rice.kim.api.identity.type.EntityTypeContactInfo	inactivateEntityTypeContactInfo(String entityId, String entityTypeCode) This will inactivate a EntityTypeContactInfo with the passed in parameters.
org.kuali.rice.kim.api.identity.name.EntityName	inactivateName(String id) This will inactivate a EntityName with the passed in id.
org.kuali.rice.kim.api.identity.phone.EntityPhone	inactivatePhone(String id) This will inactivate the EntityPhone with the passed in id.
org.kuali.rice.kim.api.identity.principal.Principal	inactivatePrincipal(String principalId) This will inactivate a Principal.
org.kuali.rice.kim.api.identity.principal.Principal	inactivatePrincipalByName(String principalName) This will inactivate a Principal.
org.kuali.rice.kim.api.identity.address.EntityAddress	updateAddress(org.kuali.rice.kim.api.identity.address.EntityAddress address) This will update a EntityAddress exactly like the address passed in.
org.kuali.rice.kim.api.identity.affiliation.EntityAffiliation	updateAffiliation(org.kuali.rice.kim.api.identity.affiliation.EntityAffiliation affiliation) This will update a EntityAffiliation exactly like the affiliation passed in.
org.kuali.rice.kim.api.identity.personal.EntityBioDemographics	updateBioDemographics(org.kuali.rice.kim.api.identity.personal.EntityBioDemographics bioDemographics) This will update a EntityBioDemographics exactly like the bioDemographics passed in.
org.kuali.rice.kim.api.identity.citizenship.EntityCitizenship	updateCitizenship(org.kuali.rice.kim.api.identity.citizenship.EntityCitizenship citizenship) This will update a EntityCitizenship exactly like the citizenship passed in.
org.kuali.rice.kim.api.identity.email.EntityEmail	updateEmail(org.kuali.rice.kim.api.identity.email.EntityEmail email) This will update a EntityEmail exactly like the email passed in.
org.kuali.rice.kim.api.identity.employment.EntityEmployment	updateEmployment(org.kuali.rice.kim.api.identity.employment.EntityEmployment employment) This will update a EntityEmployment exactly like the employment passed in.
org.kuali.rice.kim.api.identity.entity.Entity	updateEntity(org.kuali.rice.kim.api.identity.entity.Entity entity) This will update a Entity.
org.kuali.rice.kim.api.identity.type.EntityTypeContactInfo	updateEntityTypeContactInfo(org.kuali.rice.kim.api.identity.type.EntityTypeContactInfo entityTypeContactInfo) This will update a EntityTypeContactInfo exactly like the entityTypeContactInfo passed in.
org.kuali.rice.kim.api.identity.personal.EntityEthnicity	updateEthnicity(org.kuali.rice.kim.api.identity.personal.EntityEthnicity ethnicity) This will update a EntityEthnicity exactly like the ethnicity passed in.
org.kuali.rice.kim.api.identity.external.EntityExternalIdentifier	updateExternalIdentifier(org.kuali.rice.kim.api.identity.external.EntityExternalIdentifier externalId) This will update a EntityExternalIdentifier exactly like the externalId passed in.
org.kuali.rice.kim.api.identity.name.EntityName	updateName(org.kuali.rice.kim.api.identity.name.EntityName name) This will update a EntityName exactly like the name passed in.
org.kuali.rice.kim.api.identity.phone.EntityPhone	updatePhone(org.kuali.rice.kim.api.identity.phone.EntityPhone phone) This will update a EntityPhone exactly like the phone passed in.
org.kuali.rice.kim.api.identity.principal.Principal	updatePrincipal(org.kuali.rice.kim.api.identity.principal.Principal principal) This will update a Principal exactly like the principal passed in.
org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences	updatePrivacyPreferences(org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences privacyPreferences) This will update a EntityPrivacyPreferences exactly like the privacyPreferences passed in.
org.kuali.rice.kim.api.identity.residency.EntityResidency	updateResidency(org.kuali.rice.kim.api.identity.residency.EntityResidency residency) This will update a EntityResidency exactly like the residency passed in.
org.kuali.rice.kim.api.identity.visa.EntityVisa	updateVisa(org.kuali.rice.kim.api.identity.visa.EntityVisa visa) This will update a EntityVisa exactly like the visa passed in.

Method Detail

findEntityDefaults

org.kuali.rice.kim.api.identity.entity.EntityDefaultQueryResults findEntityDefaults(org.kuali.rice.core.api.criteria.QueryByCriteria query)
                                                                                    throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

This method finds EntityDefault data based on a query criteria. The criteria cannot be null.

Parameters:

query - the criteria. Cannot be null.

Returns:

query results. will never return null.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the queryByCriteria is null

findEntities

org.kuali.rice.kim.api.identity.entity.EntityQueryResults findEntities(org.kuali.rice.core.api.criteria.QueryByCriteria query)
                                                                       throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

This method finds Entities based on a query criteria. The criteria cannot be null.

Parameters:

query - the criteria. Cannot be null.

Returns:

query results. will never return null.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the queryByCriteria is null

getEntity

org.kuali.rice.kim.api.identity.entity.Entity getEntity(String id)
                                                        throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets a Entity from an id.

This method will return null if the Entity does not exist.

Parameters:

id - the unique id to retrieve the entity by. cannot be null.

Returns:

a Entity or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the id is blank

getEntityByPrincipalId

@Cacheable(value="http://rice.kuali.org/kim/v2_0/EntityType",
           key="\'principalId=\' + #p0")
org.kuali.rice.kim.api.identity.entity.Entity getEntityByPrincipalId(String principalId)
                                                                     throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets a Entity from a principalId.

This method will return null if the Entity does not exist.

Parameters:

principalId - the unique id to retrieve the entity by. cannot be null.

Returns:

a Entity or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the principalId is blank

getEntityByPrincipalName

@Cacheable(value="http://rice.kuali.org/kim/v2_0/EntityType",
           key="\'principalName=\' + #p0")
org.kuali.rice.kim.api.identity.entity.Entity getEntityByPrincipalName(String principalName)
                                                                       throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets a Entity from a principalName.

This method will return null if the Entity does not exist.

Parameters:

principalName - the unique id to retrieve the entity by. cannot be null.

Returns:

a Entity or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the id is blank

getEntityByEmployeeId

@Cacheable(value="http://rice.kuali.org/kim/v2_0/EntityType",
           key="\'employeeId=\' + #p0")
org.kuali.rice.kim.api.identity.entity.Entity getEntityByEmployeeId(String employeeId)
                                                                    throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets a Entity from a employeeId.

This method will return null if the Entity does not exist.

Parameters:

employeeId - the unique id to retrieve the entity by. cannot be null.

Returns:

a Entity or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the employeeId is blank

createEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.entity.Entity createEntity(org.kuali.rice.kim.api.identity.entity.Entity entity)
                                                           throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                  org.kuali.rice.core.api.exception.RiceIllegalStateException

This will create a Entity exactly like the entity passed in.

Parameters:

entity - the entity to create

Returns:

the newly created Entity object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the entity is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the entity already exists in the system

updateEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType","http://rice.kuali.org/kim/v2_0/EntityNamePrincipalNameType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.entity.Entity updateEntity(org.kuali.rice.kim.api.identity.entity.Entity entity)
                                                           throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                  org.kuali.rice.core.api.exception.RiceIllegalStateException

This will update a Entity.

Parameters:

entity - the entity to update

Returns:

the updated Entity object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the entity is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the entity does not already exist in the system

inactivateEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.entity.Entity inactivateEntity(String id)
                                                               throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                      org.kuali.rice.core.api.exception.RiceIllegalStateException

This will inactivate a Entity.

Parameters:

id - the unique id of the entity to inactivate

Returns:

the inactivated Entity object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the entity is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the entity does not already exist in the system

getEntityDefault

@Cacheable(value="http://rice.kuali.org/kim/v2_0/EntityDefaultType",
           key="\'id=\' + #p0")
org.kuali.rice.kim.api.identity.entity.EntityDefault getEntityDefault(String id)
                                                                      throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets a EntityDefault from an id. EntityDefault is a condensed version of Entity that contains default values of its subclasses

This method will return null if the Entity does not exist.

Parameters:

id - the unique id to retrieve the entity by. cannot be null.

Returns:

a EntityDefault or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the id is blank

getEntityDefaultByPrincipalId

@Cacheable(value="http://rice.kuali.org/kim/v2_0/EntityDefaultType",
           key="\'principalId=\' + #p0")
org.kuali.rice.kim.api.identity.entity.EntityDefault getEntityDefaultByPrincipalId(String principalId)
                                                                                   throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets a EntityDefault from an principalId. EntityDefault is a condensed version of Entity that contains default values of its subclasses

This method will return null if the Entity does not exist.

Parameters:

principalId - the unique id to retrieve the entity by. cannot be null.

Returns:

a EntityDefault or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the principalId is blank

getEntityDefaultByPrincipalName

@Cacheable(value="http://rice.kuali.org/kim/v2_0/EntityDefaultType",
           key="\'principalName=\' + #p0")
org.kuali.rice.kim.api.identity.entity.EntityDefault getEntityDefaultByPrincipalName(String principalName)
                                                                                     throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets a EntityDefault from an principalName. EntityDefault is a condensed version of Entity that contains default values of its subclasses

This method will return null if the Entity does not exist.

Parameters:

principalName - the unique id to retrieve the entity by. cannot be null.

Returns:

a EntityDefault or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the principalId is blank

getEntityDefaultByEmployeeId

@Cacheable(value="http://rice.kuali.org/kim/v2_0/EntityDefaultType",
           key="\'employeeId=\' + #p0")
org.kuali.rice.kim.api.identity.entity.EntityDefault getEntityDefaultByEmployeeId(String employeeId)
                                                                                  throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets a EntityDefault from an employeeId. EntityDefault is a condensed version of Entity that contains default values of its subclasses

This method will return null if the Entity does not exist.

Parameters:

employeeId - the unique id to retrieve the entity by. cannot be null.

Returns:

a EntityDefault or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the employeeId is blank

getPrincipal

@Cacheable(value="http://rice.kuali.org/kim/v2_0/PrincipalType",
           key="\'principalId=\' + #p0")
org.kuali.rice.kim.api.identity.principal.Principal getPrincipal(String principalId)
                                                                 throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets a Principal from an principalId.

This method will return null if the Principal does not exist.

Parameters:

principalId - the unique id to retrieve the principal by. cannot be null.

Returns:

a Principal or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the principalId is blank

getPrincipals

List<org.kuali.rice.kim.api.identity.principal.Principal> getPrincipals(List<String> principalIds)

Gets a list of Principal from a string list of principalId.

This method will only return principals that exist.

Parameters:

principalIds - the unique id to retrieve the principal by. cannot be null.

Returns:

a list of Principal

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the principalId is blank

getPrincipalsByEntityId

List<org.kuali.rice.kim.api.identity.principal.Principal> getPrincipalsByEntityId(String entityId)

Gets a list of Principal from an entityId.

This method will only return principals that exist.

Parameters:

entityId - the unique id to retrieve the principals by. cannot be null.

Returns:

a list of Principal

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the entityId is blank

getPrincipalsByEmployeeId

List<org.kuali.rice.kim.api.identity.principal.Principal> getPrincipalsByEmployeeId(String employeeId)

Gets a list of Principal from an employeeId

This method will only return principals that exist.

Parameters:

employeeId - the employee id to retrieve the principals by. cannot be null.

Returns:

a list of Principal

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the employeeId is blank

getPrincipalByPrincipalName

@Cacheable(value="http://rice.kuali.org/kim/v2_0/PrincipalType",
           key="\'principalName=\' + #p0")
org.kuali.rice.kim.api.identity.principal.Principal getPrincipalByPrincipalName(String principalName)
                                                                                throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets a Principal from an principalName.

This method will return null if the Principal does not exist.

Parameters:

principalName - the unique id to retrieve the principal by. cannot be null.

Returns:

a Principal or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

getPrincipalByPrincipalNameAndPassword

@Cacheable(value="http://rice.kuali.org/kim/v2_0/PrincipalType",
           key="\'principalName=\' + #p0 + \'|\' + \'password=\' + #p1")
org.kuali.rice.kim.api.identity.principal.Principal getPrincipalByPrincipalNameAndPassword(String principalName,
                                                                                                   String password)
                                                                                           throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets a Principal from an principalName and password.

This method will return null if the Principal does not exist or the password is incorrect.

Parameters:

principalName - the unique id to retrieve the principal by. cannot be null.

password - the password for the principal

Returns:

a Principal or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the principalName is blank

addPrincipalToEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/PrincipalType","http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.principal.Principal addPrincipalToEntity(org.kuali.rice.kim.api.identity.principal.Principal principal)
                                                                         throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                org.kuali.rice.core.api.exception.RiceIllegalStateException

This will create a Principal exactly like the principal passed in. The principal object passed in must be populated with an entityId and a principalName

Parameters:

principal - the principal to create

Returns:

the newly created Principal object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the principal is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the principal already exists in the system or the principal object is not populated with entityId and principalName

updatePrincipal

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/PrincipalType","http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType","http://rice.kuali.org/kim/v2_0/EntityNamePrincipalNameType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.principal.Principal updatePrincipal(org.kuali.rice.kim.api.identity.principal.Principal principal)
                                                                    throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                           org.kuali.rice.core.api.exception.RiceIllegalStateException

This will update a Principal exactly like the principal passed in.

Parameters:

principal - the principal to update

Returns:

the updated Principal object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the principal is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the principal does not exist in the system.

inactivatePrincipal

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/PrincipalType","http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.principal.Principal inactivatePrincipal(String principalId)
                                                                        throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                               org.kuali.rice.core.api.exception.RiceIllegalStateException

This will inactivate a Principal.

Parameters:

principalId - the unique id of the principal to inactivate

Returns:

the inactivated Principal object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the principal is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the principal does not exist in the system.

inactivatePrincipalByName

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/PrincipalType","http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.principal.Principal inactivatePrincipalByName(String principalName)
                                                                              throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                     org.kuali.rice.core.api.exception.RiceIllegalStateException

This will inactivate a Principal.

Parameters:

principalName - the unique principalName of the principal to inactivate

Returns:

the inactivated Principal object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the principal is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the principal does not exist in the system.

addEntityTypeContactInfoToEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.type.EntityTypeContactInfo addEntityTypeContactInfoToEntity(org.kuali.rice.kim.api.identity.type.EntityTypeContactInfo entityTypeContactInfo)
                                                                                            throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                                   org.kuali.rice.core.api.exception.RiceIllegalStateException

This will create a EntityTypeContactInfo exactly like the entityTypeContactInfo passed in. The EntityTypeContactInfo object passed in must be populated with an entityId and a entityTypeCode

Parameters:

entityTypeContactInfo - the EntityTypeContactInfo to create

Returns:

the newly created EntityTypeContactInfo object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the entityTypeContactInfo is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the entityTypeContactInfo already exists in the system or the EntityTypeContactInfo object is not populated with entityId and entityTypeCode

updateEntityTypeContactInfo

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.type.EntityTypeContactInfo updateEntityTypeContactInfo(org.kuali.rice.kim.api.identity.type.EntityTypeContactInfo entityTypeContactInfo)
                                                                                       throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                              org.kuali.rice.core.api.exception.RiceIllegalStateException

This will update a EntityTypeContactInfo exactly like the entityTypeContactInfo passed in.

Parameters:

entityTypeContactInfo - the EntityTypeContactInfo to update

Returns:

the updated EntityTypeContactInfo object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the entityTypeContactInfo is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the entityTypeContactInfo does not exist in the system.

inactivateEntityTypeContactInfo

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.type.EntityTypeContactInfo inactivateEntityTypeContactInfo(String entityId,
                                                                                                    String entityTypeCode)
                                                                                           throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                                  org.kuali.rice.core.api.exception.RiceIllegalStateException

This will inactivate a EntityTypeContactInfo with the passed in parameters.

Parameters:

entityId - the entityId of the EntityTypeContactInfo to inactivate

entityTypeCode - the entityTypeCode of the EntityTypeContactInfo to inactivate

Returns:

the inactivated EntityTypeContactInfo object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the entityId or entityTypeCode passed in is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the EntityTypeContactInfo does not exist in the system.

addAddressToEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.address.EntityAddress addAddressToEntity(org.kuali.rice.kim.api.identity.address.EntityAddress address)
                                                                         throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                org.kuali.rice.core.api.exception.RiceIllegalStateException

This will create a EntityAddress exactly like the address passed in. The EntityAddress object passed in must be populated with an entityId and a entityTypeCode

Parameters:

address - the EntityAddress to create

Returns:

the newly created EntityAddress object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the address is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the address already exists in the system or address is not populated with entityId and entityTypeCode

updateAddress

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.address.EntityAddress updateAddress(org.kuali.rice.kim.api.identity.address.EntityAddress address)
                                                                    throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                           org.kuali.rice.core.api.exception.RiceIllegalStateException

This will update a EntityAddress exactly like the address passed in.

Parameters:

address - the EntityAddress to update

Returns:

the updated EntityAddress object.

Throws:

IllegalArgumentException - if the address is null

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the address does not exist in the system.

org.kuali.rice.core.api.exception.RiceIllegalStateException

inactivateAddress

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.address.EntityAddress inactivateAddress(String id)
                                                                        throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                               org.kuali.rice.core.api.exception.RiceIllegalStateException

This will inactivate a EntityAddress with the id passed in.

Parameters:

id - the unique id of the EntityAddress to inactivate

Returns:

the updated EntityAddress object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the id is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the address does not exist in the system.

addEmailToEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.email.EntityEmail addEmailToEntity(org.kuali.rice.kim.api.identity.email.EntityEmail email)
                                                                   throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                          org.kuali.rice.core.api.exception.RiceIllegalStateException

This will create a EntityEmail exactly like the email passed in. The EntityEmail object passed in must be populated with an entityId and a entityTypeCode

Parameters:

email - the EntityEmail to create

Returns:

the newly created EntityEmail object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the email is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the email already exists in the system or email is not populated with entityId and entityTypeCode

updateEmail

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.email.EntityEmail updateEmail(org.kuali.rice.kim.api.identity.email.EntityEmail email)
                                                              throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                     org.kuali.rice.core.api.exception.RiceIllegalStateException

This will update a EntityEmail exactly like the email passed in.

Parameters:

email - the EntityEmail to update

Returns:

the updated EntityEmail object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the email is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the email does not exist in the system.

inactivateEmail

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.email.EntityEmail inactivateEmail(String id)
                                                                  throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                         org.kuali.rice.core.api.exception.RiceIllegalStateException

This will inactivate the EntityEmail with the passed in id.

Parameters:

id - the unique id of the EntityEmail to inactivate

Returns:

the inactivated EntityEmail object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the id is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the email does not exist in the system.

addPhoneToEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.phone.EntityPhone addPhoneToEntity(org.kuali.rice.kim.api.identity.phone.EntityPhone phone)
                                                                   throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                          org.kuali.rice.core.api.exception.RiceIllegalStateException

This will create a EntityPhone exactly like the phone passed in. The EntityPhone object passed in must be populated with an entityId and a entityTypeCode

Parameters:

phone - the EntityPhone to create

Returns:

the newly created EntityPhone object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the phone is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the phone already exists in the system or phone is not populated with entityId and entityTypeCode

updatePhone

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.phone.EntityPhone updatePhone(org.kuali.rice.kim.api.identity.phone.EntityPhone phone)
                                                              throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                     org.kuali.rice.core.api.exception.RiceIllegalStateException

This will update a EntityPhone exactly like the phone passed in.

Parameters:

phone - the EntityPhone to update

Returns:

the updated EntityPhone object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the phone is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the phone does not exist in the system.

inactivatePhone

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.phone.EntityPhone inactivatePhone(String id)
                                                                  throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                         org.kuali.rice.core.api.exception.RiceIllegalStateException

This will inactivate the EntityPhone with the passed in id.

Parameters:

id - the unique id of the EntityPhone to inactivate

Returns:

the inactivated EntityPhone object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the id is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the phone does not exist in the system.

addExternalIdentifierToEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.external.EntityExternalIdentifier addExternalIdentifierToEntity(org.kuali.rice.kim.api.identity.external.EntityExternalIdentifier externalId)
                                                                                                throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                                       org.kuali.rice.core.api.exception.RiceIllegalStateException

This will create a EntityExternalIdentifier exactly like the externalId passed in. The EntityExternalIdentifier object passed in must be populated with an entityId and a externalIdentifierTypeCode

Parameters:

externalId - the EntityExternalIdentifier to create

Returns:

the newly created EntityExternalIdentifier object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the externalId is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the externalId already exists in the system or externalId is not populated with entityId and externalIdentifierTypeCode

updateExternalIdentifier

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.external.EntityExternalIdentifier updateExternalIdentifier(org.kuali.rice.kim.api.identity.external.EntityExternalIdentifier externalId)
                                                                                           throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                                  org.kuali.rice.core.api.exception.RiceIllegalStateException

This will update a EntityExternalIdentifier exactly like the externalId passed in.

Parameters:

externalId - the EntityExternalIdentifier to update

Returns:

the updated EntityExternalIdentifier object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the externalId is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the externalId does not exist in the system.

addAffiliationToEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.affiliation.EntityAffiliation addAffiliationToEntity(org.kuali.rice.kim.api.identity.affiliation.EntityAffiliation affiliation)
                                                                                     throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                            org.kuali.rice.core.api.exception.RiceIllegalStateException

This will create a EntityAffiliation exactly like the affiliation passed in. The EntityAffiliation object passed in must be populated with an entityId and a affiliationType

Parameters:

affiliation - the EntityAffiliation to create

Returns:

the newly created EntityAffiliation object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the affiliation is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the affiliation already exists in the system or affiliation is not populated with entityId and affiliationType

updateAffiliation

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.affiliation.EntityAffiliation updateAffiliation(org.kuali.rice.kim.api.identity.affiliation.EntityAffiliation affiliation)
                                                                                throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                       org.kuali.rice.core.api.exception.RiceIllegalStateException

This will update a EntityAffiliation exactly like the affiliation passed in.

Parameters:

affiliation - the EntityAffiliation to update

Returns:

the updated EntityAffiliation object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the affiliation is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the affiliation does not exist in the system.

inactivateAffiliation

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.affiliation.EntityAffiliation inactivateAffiliation(String id)
                                                                                    throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                           org.kuali.rice.core.api.exception.RiceIllegalStateException

This will inactivate a EntityAffiliation with the id passed in.

Parameters:

id - the unique id of the EntityAffiliation to inactivate

Returns:

the updated EntityAffiliation object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the affiliation is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the affiliation does not exist in the system.

getDefaultNamesForPrincipalId

@Cacheable(value="http://rice.kuali.org/kim/v2_0/EntityNamePrincipalNameType",
           key="\'principalId=\' + #p0")
org.kuali.rice.kim.api.identity.principal.EntityNamePrincipalName getDefaultNamesForPrincipalId(String principalId)

This returns the display name information for the given principal without loading the full person object.

Parameters:

principalId - The principal ID to find the name information for

Returns:

The default name information for the principal

addNameToEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType","http://rice.kuali.org/kim/v2_0/EntityNamePrincipalNameType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.name.EntityName addNameToEntity(org.kuali.rice.kim.api.identity.name.EntityName name)
                                                                throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                       org.kuali.rice.core.api.exception.RiceIllegalStateException

This will create a EntityName exactly like the name passed in. The EntityName object passed in must be populated with an entityId and a nameType

Parameters:

name - the EntityName to create

Returns:

the newly created EntityName object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the name is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the name already exists in the system or name is not populated with entityId and nameType

updateName

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType","http://rice.kuali.org/kim/v2_0/EntityNamePrincipalNameType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.name.EntityName updateName(org.kuali.rice.kim.api.identity.name.EntityName name)
                                                           throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                  org.kuali.rice.core.api.exception.RiceIllegalStateException

This will update a EntityName exactly like the name passed in.

Parameters:

name - the EntityName to update

Returns:

the updated EntityName object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the name is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the name does not exist in the system.

inactivateName

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.name.EntityName inactivateName(String id)
                                                               throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                      org.kuali.rice.core.api.exception.RiceIllegalStateException

This will inactivate a EntityName with the passed in id.

Parameters:

id - the unique id of the EntityName to inactivate

Returns:

the inactivated EntityName object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the id is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the name with the id does not exist in the system.

addEmploymentToEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.employment.EntityEmployment addEmploymentToEntity(org.kuali.rice.kim.api.identity.employment.EntityEmployment employment)
                                                                                  throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                         org.kuali.rice.core.api.exception.RiceIllegalStateException

This will create a EntityEmployment exactly like the employment passed in. The EntityEmployment object passed in must be populated with an entityId and a employmentType

Parameters:

employment - the EntityEmployment to create

Returns:

the newly created EntityName object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the employment is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the employment already exists in the system or employment is not populated with entityId and employmentType

updateEmployment

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.employment.EntityEmployment updateEmployment(org.kuali.rice.kim.api.identity.employment.EntityEmployment employment)
                                                                             throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                    org.kuali.rice.core.api.exception.RiceIllegalStateException

This will update a EntityEmployment exactly like the employment passed in.

Parameters:

employment - the EntityEmployment to update

Returns:

the updated EntityEmployment object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the employment is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the employment does not exist in the system.

inactivateEmployment

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.employment.EntityEmployment inactivateEmployment(String id)
                                                                                 throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                        org.kuali.rice.core.api.exception.RiceIllegalStateException

This will inactivate a EntityEmployment with the passed in id.

Parameters:

id - the unique id of the EntityEmployment to inactivate

Returns:

the inactivated EntityEmployment object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the id is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the employment with the id does not exist in the system.

addBioDemographicsToEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.personal.EntityBioDemographics addBioDemographicsToEntity(org.kuali.rice.kim.api.identity.personal.EntityBioDemographics bioDemographics)
                                                                                          throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                                 org.kuali.rice.core.api.exception.RiceIllegalStateException

This will create a EntityBioDemographics exactly like the bioDemographics passed in. The EntityBioDemographics object passed in must be populated with an entityId

Parameters:

bioDemographics - the EntityBioDemographics to create

Returns:

the newly created EntityBioDemographics object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the bioDemographics is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the bioDemographics already exists in the system or bioDemographics is not populated with entityId

updateBioDemographics

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.personal.EntityBioDemographics updateBioDemographics(org.kuali.rice.kim.api.identity.personal.EntityBioDemographics bioDemographics)
                                                                                     throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                            org.kuali.rice.core.api.exception.RiceIllegalStateException

This will update a EntityBioDemographics exactly like the bioDemographics passed in.

Parameters:

bioDemographics - the EntityBioDemographics to update

Returns:

the updated EntityBioDemographics object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the bioDemographics is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the bioDemographics does not exist in the system.

getEntityPrivacyPreferences

@Cacheable(value="http://rice.kuali.org/kim/v2_0/EntityPrivacyPreferencesType",
           key="\'id=\' + #p0")
org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences getEntityPrivacyPreferences(String id)
                                                                                             throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets a EntityPrivacyPreferences for a given id.

This method will return null if the EntityPrivacyPreferences does not exist.

Parameters:

id - the unique id to retrieve the EntityPrivacyPreferences by. Cannot be null.

Returns:

a EntityPrivacyPreferences or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the entityId is blank

addPrivacyPreferencesToEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType","http://rice.kuali.org/kim/v2_0/EntityPrivacyPreferencesType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences addPrivacyPreferencesToEntity(org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences privacyPreferences)
                                                                                               throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                                      org.kuali.rice.core.api.exception.RiceIllegalStateException

This will create a EntityPrivacyPreferences exactly like the privacyPreferences passed in. The EntityPrivacyPreferences object passed in must be populated with an entityId

Parameters:

privacyPreferences - the EntityPrivacyPreferences to create

Returns:

the newly created EntityPrivacyPreferences object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the privacyPreferences is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the privacyPreferences already exists in the system or privacyPreferences is not populated with entityId

updatePrivacyPreferences

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType","http://rice.kuali.org/kim/v2_0/EntityPrivacyPreferencesType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences updatePrivacyPreferences(org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences privacyPreferences)
                                                                                          throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                                 org.kuali.rice.core.api.exception.RiceIllegalStateException

This will update a EntityPrivacyPreferences exactly like the privacyPreferences passed in.

Parameters:

privacyPreferences - the EntityPrivacyPreferences to update

Returns:

the updated EntityPrivacyPreferences object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the privacyPreferences is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the privacyPreferences does not exist in the system.

addCitizenshipToEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.citizenship.EntityCitizenship addCitizenshipToEntity(org.kuali.rice.kim.api.identity.citizenship.EntityCitizenship citizenship)
                                                                                     throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                            org.kuali.rice.core.api.exception.RiceIllegalStateException

This will create a EntityCitizenship exactly like the citizenship passed in. The EntityCitizenship object passed in must be populated with an entityId and a status

Parameters:

citizenship - the EntityCitizenship to create

Returns:

the newly created EntityCitizenship object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the citizenship is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the citizenship already exists in the system or citizenship is not populated with entityId and status

updateCitizenship

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.citizenship.EntityCitizenship updateCitizenship(org.kuali.rice.kim.api.identity.citizenship.EntityCitizenship citizenship)
                                                                                throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                       org.kuali.rice.core.api.exception.RiceIllegalStateException

This will update a EntityCitizenship exactly like the citizenship passed in.

Parameters:

citizenship - the EntityCitizenship to update

Returns:

the updated EntityCitizenship object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the citizenship is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the citizenship does not exist in the system.

inactivateCitizenship

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.citizenship.EntityCitizenship inactivateCitizenship(String id)
                                                                                    throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                           org.kuali.rice.core.api.exception.RiceIllegalStateException

This will inactivate a EntityCitizenship with the unique id passed in.

Parameters:

id - the id of the EntityCitizenship to inactivate

Returns:

the inactivated EntityCitizenship object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the citizenship is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the citizenship does not exist in the system.

addEthnicityToEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.personal.EntityEthnicity addEthnicityToEntity(org.kuali.rice.kim.api.identity.personal.EntityEthnicity ethnicity)
                                                                              throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                     org.kuali.rice.core.api.exception.RiceIllegalStateException

This will create a EntityEthnicity exactly like the ethnicity passed in. The EntityEthnicity object passed in must be populated with an entityId and a ethnicity code

Parameters:

ethnicity - the EntityEthnicity to create

Returns:

the newly created EntityEthnicity object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the ethnicity is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the ethnicity already exists in the system or ethnicity is not populated with entityId and ethnicity code

updateEthnicity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.personal.EntityEthnicity updateEthnicity(org.kuali.rice.kim.api.identity.personal.EntityEthnicity ethnicity)
                                                                         throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                org.kuali.rice.core.api.exception.RiceIllegalStateException

This will update a EntityEthnicity exactly like the ethnicity passed in.

Parameters:

ethnicity - the EntityEthnicity to update

Returns:

the updated EntityEthnicity object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the ethnicity is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the ethnicity does not exist in the system.

addResidencyToEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.residency.EntityResidency addResidencyToEntity(org.kuali.rice.kim.api.identity.residency.EntityResidency residency)
                                                                               throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                      org.kuali.rice.core.api.exception.RiceIllegalStateException

This will create a EntityResidency exactly like the residency passed in. The EntityResidency object passed in must be populated with an entityId

Parameters:

residency - the EntityResidency to create

Returns:

the newly created EntityResidency object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the residency is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the residency already exists in the system or residency is not populated with entityId

updateResidency

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.residency.EntityResidency updateResidency(org.kuali.rice.kim.api.identity.residency.EntityResidency residency)
                                                                          throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                 org.kuali.rice.core.api.exception.RiceIllegalStateException

This will update a EntityResidency exactly like the residency passed in.

Parameters:

residency - the EntityResidency to update

Returns:

the updated EntityResidency object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the residency is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the residency does not exist in the system.

addVisaToEntity

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.visa.EntityVisa addVisaToEntity(org.kuali.rice.kim.api.identity.visa.EntityVisa visa)
                                                                throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                       org.kuali.rice.core.api.exception.RiceIllegalStateException

This will create a EntityVisa exactly like the visa passed in. The EntityVisa object passed in must be populated with an entityId and a visaTypeKey

Parameters:

visa - the EntityVisa to create

Returns:

the newly created EntityVisa object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the visa is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the visa already exists in the system or visa is not populated with entityId and a visaTypeKey

updateVisa

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType"},
            allEntries=true)
org.kuali.rice.kim.api.identity.visa.EntityVisa updateVisa(org.kuali.rice.kim.api.identity.visa.EntityVisa visa)
                                                           throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                  org.kuali.rice.core.api.exception.RiceIllegalStateException

This will update a EntityVisa exactly like the visa passed in.

Parameters:

visa - the EntityVisa to update

Returns:

the updated EntityVisa object.

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the visa is null

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the visa does not exist in the system.

getEntityType

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{EntityType}",
           key="\'code=\' + #p0")
org.kuali.rice.kim.api.identity.CodedAttribute getEntityType(String code)
                                                             throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets the CodedAttribute for a given EntityType code.

This method will return null if the code does not exist.

Parameters:

code - the unique id to retrieve the Type by. Cannot be null.

Returns:

a CodedAttribute or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the code is blank

findAllEntityTypes

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{EntityType}",
           key="\'all\'")
List<org.kuali.rice.kim.api.identity.CodedAttribute> findAllEntityTypes()

Finds all EntityTypes

Returns:

a list of CodedAttribute

Since:

2.0.1

getAddressType

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{AddressType}",
           key="\'code=\' + #p0")
org.kuali.rice.kim.api.identity.CodedAttribute getAddressType(String code)
                                                              throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets the CodedAttribute for a given EntityAddressType code.

This method will return null if the code does not exist.

Parameters:

code - the unique id to retrieve the Type by. Cannot be null.

Returns:

a CodedAttribute or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the code is blank

findAllAddressTypes

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{AddressType}",
           key="\'all\'")
List<org.kuali.rice.kim.api.identity.CodedAttribute> findAllAddressTypes()

Finds all EntityAddressTypes

Returns:

a list of CodedAttribute

Since:

2.0.1

getAffiliationType

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{AffiliationType}",
           key="\'code=\' + #p0")
org.kuali.rice.kim.api.identity.affiliation.EntityAffiliationType getAffiliationType(String code)
                                                                                     throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets the EntityAffiliationType for a given EntityAffiliationType code.

This method will return null if the code does not exist.

Parameters:

code - the unique id to retrieve the EntityAffiliationType by. Cannot be null.

Returns:

a EntityAffiliationType or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the code is blank

findAllAffiliationTypes

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{AffiliationType}",
           key="\'all\'")
List<org.kuali.rice.kim.api.identity.affiliation.EntityAffiliationType> findAllAffiliationTypes()

Finds all EntityAffiliationTypes

Returns:

a list of EntityAffiliationType

Since:

2.0.1

getCitizenshipStatus

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{CitizenshipStatus}",
           key="\'code=\' + #p0")
org.kuali.rice.kim.api.identity.CodedAttribute getCitizenshipStatus(String code)
                                                                    throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets the CodedAttribute for a given EntityCitizenship status code.

This method will return null if the code does not exist.

Parameters:

code - the unique id to retrieve the Type by. Cannot be null.

Returns:

a CodedAttribute or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the code is blank

findAllCitizenshipStatuses

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{CitizenshipStatus}",
           key="\'all\'")
List<org.kuali.rice.kim.api.identity.CodedAttribute> findAllCitizenshipStatuses()

Finds all EntityCitizenshipStatuses

Returns:

a list of CodedAttribute

Since:

2.0.1

getEmploymentType

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{EmploymentType}",
           key="\'code=\' + #p0")
org.kuali.rice.kim.api.identity.CodedAttribute getEmploymentType(String code)
                                                                 throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets the CodedAttribute for a given EntityEmployment type code.

This method will return null if the code does not exist.

Parameters:

code - the unique id to retrieve the Type by. Cannot be null.

Returns:

a CodedAttribute or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the code is blank

findAllEmploymentTypes

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{EmploymentType}",
           key="\'all\'")
List<org.kuali.rice.kim.api.identity.CodedAttribute> findAllEmploymentTypes()

Finds all EntityEmploymentTypes

Returns:

a list of CodedAttribute

Since:

2.0.1

getEmploymentStatus

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{EmploymentStatus}",
           key="\'code=\' + #p0")
org.kuali.rice.kim.api.identity.CodedAttribute getEmploymentStatus(String code)
                                                                   throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets the CodedAttribute for a given EntityEmployment status code.

This method will return null if the code does not exist.

Parameters:

code - the unique id to retrieve the Type by. Cannot be null.

Returns:

a CodedAttribute or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the code is blank

findAllEmploymentStatuses

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{EmploymentStatus}",
           key="\'all\'")
List<org.kuali.rice.kim.api.identity.CodedAttribute> findAllEmploymentStatuses()

Finds all EntityEmploymentStatuses

Returns:

a list of CodedAttribute

Since:

2.0.1

getExternalIdentifierType

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{ExternalIdentifierType}",
           key="\'code=\' + #p0")
org.kuali.rice.kim.api.identity.external.EntityExternalIdentifierType getExternalIdentifierType(String code)
                                                                                                throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets the EntityExternalIdentifierType for a given type code.

This method will return null if the code does not exist.

Parameters:

code - the unique id to retrieve the EntityExternalIdentifierType by. Cannot be null.

Returns:

a CodedAttribute or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the code is blank

findAllExternalIdendtifierTypes

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{ExternalIdentifierType}",
           key="\'all\'")
List<org.kuali.rice.kim.api.identity.external.EntityExternalIdentifierType> findAllExternalIdendtifierTypes()

Finds all ExternalIdentifierTypes

Returns:

a list of EntityExternalIdentifierType

Since:

2.0.1

getNameType

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{NameType}",
           key="\'code=\' + #p0")
org.kuali.rice.kim.api.identity.CodedAttribute getNameType(String code)
                                                           throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets the CodedAttribute for a given EntityName type code.

This method will return null if the code does not exist.

Parameters:

code - the unique id to retrieve the Type by. Cannot be null.

Returns:

a CodedAttribute or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the code is blank

findAllNameTypes

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{NameType}",
           key="\'all\'")
List<org.kuali.rice.kim.api.identity.CodedAttribute> findAllNameTypes()

Finds all EntityNameTypes

Returns:

a list of CodedAttribute

Since:

2.0.1

getPhoneType

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{PhoneType}",
           key="\'code=\' + #p0")
org.kuali.rice.kim.api.identity.CodedAttribute getPhoneType(String code)
                                                            throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets the CodedAttribute for a given EntityPhone type code.

This method will return null if the code does not exist.

Parameters:

code - the unique id to retrieve the Type by. Cannot be null.

Returns:

a CodedAttribute or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the code is blank

findAllPhoneTypes

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{PhoneType}",
           key="\'all\'")
List<org.kuali.rice.kim.api.identity.CodedAttribute> findAllPhoneTypes()

Finds all EntityPhoneTypes

Returns:

a list of CodedAttribute

Since:

2.0.1

getEmailType

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{EmailType}",
           key="\'code=\' + #p0")
org.kuali.rice.kim.api.identity.CodedAttribute getEmailType(String code)
                                                            throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Gets the CodedAttribute for a given EntityEmail type code.

This method will return null if the code does not exist.

Parameters:

code - the unique id to retrieve the Type by. Cannot be null.

Returns:

a CodedAttribute or null

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the code is blank

findAllEmailTypes

@Cacheable(value="http://rice.kuali.org/kim/v2_0/CodedAttributeType{EmailType}",
           key="\'all\'")
List<org.kuali.rice.kim.api.identity.CodedAttribute> findAllEmailTypes()

Finds all EntityEmailTypes

Returns:

a list of CodedAttribute

Since:

2.0.1

findPrincipals

org.kuali.rice.kim.api.identity.principal.PrincipalQueryResults findPrincipals(org.kuali.rice.core.api.criteria.QueryByCriteria query)
                                                                               throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

This method finds Principals based on a query criteria. The criteria cannot be null.

Parameters:

query - the criteria. Cannot be null.

Returns:

query results. will never return null.

Throws:

IllegalArgumentException - if the queryByCriteria is null

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Since:

2.0.1