IdentityService

• findEntityDefaults
• findEntities
• getEntity
• getEntityByPrincipalId
• getEntityByPrincipalName
• getEntityByEmployeeId
• createEntity
• updateEntity
• inactivateEntity
• getEntityDefault
• getEntityDefaultByPrincipalId
• getEntityDefaultByPrincipalName
• getEntityDefaultByEmployeeId
• getPrincipal
• getPrincipals
• getPrincipalByPrincipalName
• getPrincipalByPrincipalNameAndPassword
• addPrincipalToEntity
• updatePrincipal
• inactivatePrincipal
• inactivatePrincipalByName
• addEntityTypeContactInfoToEntity
• updateEntityTypeContactInfo
• inactivateEntityTypeContactInfo
• addAddressToEntity
• updateAddress
• inactivateAddress
• addEmailToEntity
• updateEmail
• inactivateEmail
• addPhoneToEntity
• updatePhone
• inactivatePhone
• addExternalIdentifierToEntity
• updateExternalIdentifier
• addAffiliationToEntity
• updateAffiliation
• inactivateAffiliation
• getDefaultNamesForPrincipalId
• addNameToEntity
• updateName
• inactivateName
• addEmploymentToEntity
• updateEmployment
• inactivateEmployment
• addBioDemographicsToEntity
• updateBioDemographics
• getEntityPrivacyPreferences
• addPrivacyPreferencesToEntity
• updatePrivacyPreferences
• addCitizenshipToEntity
• updateCitizenship
• inactivateCitizenship
• addEthnicityToEntity
• updateEthnicity
• addResidencyToEntity
• updateResidency
• addVisaToEntity
• updateVisa
• getEntityType
• findAllEntityTypes
• getAddressType
• findAllAddressTypes
• getAffiliationType
• findAllAffiliationTypes
• getCitizenshipStatus
• findAllCitizenshipStatuses
• getEmploymentType
• findAllEmploymentTypes
• getEmploymentStatus
• findAllEmploymentStatuses
• getExternalIdentifierType
• findAllExternalIdendtifierTypes
• getNameType
• findAllNameTypes
• getPhoneType
• findAllPhoneTypes
• getEmailType
• findAllEmailTypes
• findPrincipals

• EntityDefaultQueryResults
• QueryByCriteria
• EntityQueryResults
• Entity
• EntityDefault
• Principal
• EntityTypeContactInfo
• EntityAddress
• EntityEmail
• EntityPhone
• EntityExternalIdentifier
• EntityAffiliation
• EntityNamePrincipalName
• EntityName
• EntityEmployment
• EntityBioDemographics
• EntityPrivacyPreferences
• EntityCitizenship
• EntityEthnicity
• EntityResidency
• EntityVisa
• CodedAttribute
• EntityAffiliationType
• EntityExternalIdentifierType
• PrincipalQueryResults

Method	findEntityDefaults
Description	This method finds EntityDefault data based on a query criteria. The criteria cannot be null.
Parameters	QueryByCriteria	query	the criteria. Cannot be null.
Return	EntityDefaultQueryResults		query results. will never return null.
Errors	RiceIllegalArgumentException		if the queryByCriteria is null

Back to Operations

Method	findEntities
Description	This method finds Entities based on a query criteria. The criteria cannot be null.
Parameters	QueryByCriteria	query	the criteria. Cannot be null.
Return	EntityQueryResults		query results. will never return null.
Errors	RiceIllegalArgumentException		if the queryByCriteria is null

Back to Operations

Method	getEntity
Description	Gets a {@link org.kuali.rice.kim.api.identity.entity.Entity} from an id. This method will return null if the Entity does not exist.
Parameters	String	id	the unique id to retrieve the entity by. cannot be null.
Return	Entity		a {@link org.kuali.rice.kim.api.identity.entity.Entity} or null
Errors	RiceIllegalArgumentException		if the id is blank

Back to Operations

Method	getEntityByPrincipalId
Description	Gets a {@link org.kuali.rice.kim.api.identity.entity.Entity} from a principalId. This method will return null if the Entity does not exist.
Parameters	String	principalId	the unique id to retrieve the entity by. cannot be null.
Return	Entity		a {@link org.kuali.rice.kim.api.identity.entity.Entity} or null
Errors	RiceIllegalArgumentException		if the principalId is blank

Back to Operations

Method	getEntityByPrincipalName
Description	Gets a {@link org.kuali.rice.kim.api.identity.entity.Entity} from a principalName. This method will return null if the Entity does not exist.
Parameters	String	principalName	the unique id to retrieve the entity by. cannot be null.
Return	Entity		a {@link org.kuali.rice.kim.api.identity.entity.Entity} or null
Errors	RiceIllegalArgumentException		if the id is blank

Back to Operations

Method	getEntityByEmployeeId
Description	Gets a {@link org.kuali.rice.kim.api.identity.entity.Entity} from a employeeId. This method will return null if the Entity does not exist.
Parameters	String	employeeId	the unique id to retrieve the entity by. cannot be null.
Return	Entity		a {@link org.kuali.rice.kim.api.identity.entity.Entity} or null
Errors	RiceIllegalArgumentException		if the employeeId is blank

Back to Operations

Method	createEntity
Description	This will create a {@link org.kuali.rice.kim.api.identity.entity.Entity} exactly like the entity passed in.
Parameters	Entity	entity	the entity to create
Return	Entity		the newly created Entity object.
Errors	RiceIllegalArgumentException		if the entity is null
	RiceIllegalStateException		if the entity already exists in the system

Back to Operations

Method	updateEntity
Description	This will update a {@link org.kuali.rice.kim.api.identity.entity.Entity}.
Parameters	Entity	entity	the entity to update
Return	Entity		the updated Entity object.
Errors	RiceIllegalArgumentException		if the entity is null
	RiceIllegalStateException		if the entity does not already exist in the system

Back to Operations

Method	inactivateEntity
Description	This will inactivate a {@link org.kuali.rice.kim.api.identity.entity.Entity}.
Parameters	String	id	the unique id of the entity to inactivate
Return	Entity		the inactivated Entity object.
Errors	RiceIllegalArgumentException		if the entity is null
	RiceIllegalStateException		if the entity does not already exist in the system

Back to Operations

Method	getEntityDefault
Description	Gets a {@link org.kuali.rice.kim.api.identity.entity.EntityDefault} from an id. {@link org.kuali.rice.kim.api.identity.entity.EntityDefault} is a condensed version of {@link org.kuali.rice.kim.api.identity.entity.Entity} that contains default values of its subclasses This method will return null if the Entity does not exist.
Parameters	String	id	the unique id to retrieve the entity by. cannot be null.
Return	EntityDefault		a {@link org.kuali.rice.kim.api.identity.entity.EntityDefault} or null
Errors	RiceIllegalArgumentException		if the id is blank

Back to Operations

Method	getEntityDefaultByPrincipalId
Description	Gets a {@link org.kuali.rice.kim.api.identity.entity.EntityDefault} from an principalId. {@link org.kuali.rice.kim.api.identity.entity.EntityDefault} is a condensed version of {@link org.kuali.rice.kim.api.identity.entity.Entity} that contains default values of its subclasses This method will return null if the Entity does not exist.
Parameters	String	principalId	the unique id to retrieve the entity by. cannot be null.
Return	EntityDefault		a {@link org.kuali.rice.kim.api.identity.entity.EntityDefault} or null
Errors	RiceIllegalArgumentException		if the principalId is blank

Back to Operations

Method	getEntityDefaultByPrincipalName
Description	Gets a {@link org.kuali.rice.kim.api.identity.entity.EntityDefault} from an principalName. {@link org.kuali.rice.kim.api.identity.entity.EntityDefault} is a condensed version of {@link org.kuali.rice.kim.api.identity.entity.Entity} that contains default values of its subclasses This method will return null if the Entity does not exist.
Parameters	String	principalName	the unique id to retrieve the entity by. cannot be null.
Return	EntityDefault		a {@link org.kuali.rice.kim.api.identity.entity.EntityDefault} or null
Errors	RiceIllegalArgumentException		if the principalId is blank

Back to Operations

Method	getEntityDefaultByEmployeeId
Description	Gets a {@link org.kuali.rice.kim.api.identity.entity.EntityDefault} from an employeeId. {@link org.kuali.rice.kim.api.identity.entity.EntityDefault} is a condensed version of {@link org.kuali.rice.kim.api.identity.entity.Entity} that contains default values of its subclasses This method will return null if the Entity does not exist.
Parameters	String	employeeId	the unique id to retrieve the entity by. cannot be null.
Return	EntityDefault		a {@link org.kuali.rice.kim.api.identity.entity.EntityDefault} or null
Errors	RiceIllegalArgumentException		if the employeeId is blank

Back to Operations

Method	getPrincipal
Description	Gets a {@link org.kuali.rice.kim.api.identity.principal.Principal} from an principalId. This method will return null if the Principal does not exist.
Parameters	String	principalId	the unique id to retrieve the principal by. cannot be null.
Return	Principal		a {@link org.kuali.rice.kim.api.identity.principal.Principal} or null
Errors	RiceIllegalArgumentException		if the principalId is blank

Back to Operations

Method	getPrincipals
Description	Gets a list of {@link org.kuali.rice.kim.api.identity.principal.Principal} from a string list of principalId. This method will only return principals that exist.
Parameters	StringList	principalIds	the unique id to retrieve the principal by. cannot be null.
Return	PrincipalList		a list of {@link org.kuali.rice.kim.api.identity.principal.Principal}
Errors	NONE		No Errors

Back to Operations

Method	getPrincipalByPrincipalName
Description	Gets a {@link org.kuali.rice.kim.api.identity.principal.Principal} from an principalName. This method will return null if the Principal does not exist.
Parameters	String	principalName	the unique id to retrieve the principal by. cannot be null.
Return	Principal		a {@link org.kuali.rice.kim.api.identity.principal.Principal} or null
Errors	RiceIllegalArgumentException		???

Back to Operations

Method	getPrincipalByPrincipalNameAndPassword
Description	Gets a {@link org.kuali.rice.kim.api.identity.principal.Principal} from an principalName and password. This method will return null if the Principal does not exist or the password is incorrect.
Parameters	String	principalName	the unique id to retrieve the principal by. cannot be null.
	String	password	the password for the principal
Return	Principal		a {@link org.kuali.rice.kim.api.identity.principal.Principal} or null
Errors	RiceIllegalArgumentException		if the principalName is blank

Back to Operations

Method	addPrincipalToEntity
Description	This will create a {@link org.kuali.rice.kim.api.identity.principal.Principal} exactly like the principal passed in. The principal object passed in must be populated with an entityId and a principalName
Parameters	Principal	principal	the principal to create
Return	Principal		the newly created Principal object.
Errors	RiceIllegalArgumentException		if the principal is null
	RiceIllegalStateException		if the principal already exists in the system or the principal object is not populated with entityId and principalName

Back to Operations

Method	updatePrincipal
Description	This will update a {@link org.kuali.rice.kim.api.identity.principal.Principal} exactly like the principal passed in.
Parameters	Principal	principal	the principal to update
Return	Principal		the updated Principal object.
Errors	RiceIllegalArgumentException		if the principal is null
	RiceIllegalStateException		if the principal does not exist in the system.

Back to Operations

Method	inactivatePrincipal
Description	This will inactivate a {@link org.kuali.rice.kim.api.identity.principal.Principal}.
Parameters	String	principalId	the unique id of the principal to inactivate
Return	Principal		the inactivated Principal object.
Errors	RiceIllegalArgumentException		if the principal is null
	RiceIllegalStateException		if the principal does not exist in the system.

Back to Operations

Method	inactivatePrincipalByName
Description	This will inactivate a {@link org.kuali.rice.kim.api.identity.principal.Principal}.
Parameters	String	principalName	the unique principalName of the principal to inactivate
Return	Principal		the inactivated Principal object.
Errors	RiceIllegalArgumentException		if the principal is null
	RiceIllegalStateException		if the principal does not exist in the system.

Back to Operations

Method	addEntityTypeContactInfoToEntity
Description	This will create a {@link org.kuali.rice.kim.api.identity.type.EntityTypeContactInfo} exactly like the entityTypeContactInfo passed in. The EntityTypeContactInfo object passed in must be populated with an entityId and a entityTypeCode
Parameters	EntityTypeContactInfo	entityTypeContactInfo	the EntityTypeContactInfo to create
Return	EntityTypeContactInfo		the newly created EntityTypeContactInfo object.
Errors	RiceIllegalArgumentException		if the entityTypeContactInfo is null
	RiceIllegalStateException		if the entityTypeContactInfo already exists in the system or the EntityTypeContactInfo object is not populated with entityId and entityTypeCode

Back to Operations

Method	updateEntityTypeContactInfo
Description	This will update a {@link org.kuali.rice.kim.api.identity.type.EntityTypeContactInfo} exactly like the entityTypeContactInfo passed in.
Parameters	EntityTypeContactInfo	entityTypeContactInfo	the EntityTypeContactInfo to update
Return	EntityTypeContactInfo		the updated EntityTypeContactInfo object.
Errors	RiceIllegalArgumentException		if the entityTypeContactInfo is null
	RiceIllegalStateException		if the entityTypeContactInfo does not exist in the system.

Back to Operations

Method	inactivateEntityTypeContactInfo
Description	This will inactivate a {@link org.kuali.rice.kim.api.identity.type.EntityTypeContactInfo} with the passed in parameters.
Parameters	String	entityId	the entityId of the EntityTypeContactInfo to inactivate
	String	entityTypeCode	the entityTypeCode of the EntityTypeContactInfo to inactivate
Return	EntityTypeContactInfo		the inactivated EntityTypeContactInfo object.
Errors	RiceIllegalArgumentException		if the entityId or entityTypeCode passed in is null
	RiceIllegalStateException		if the EntityTypeContactInfo does not exist in the system.

Back to Operations

Method	addAddressToEntity
Description	This will create a {@link org.kuali.rice.kim.api.identity.address.EntityAddress} exactly like the address passed in. The EntityAddress object passed in must be populated with an entityId and a entityTypeCode
Parameters	EntityAddress	address	the EntityAddress to create
Return	EntityAddress		the newly created EntityAddress object.
Errors	RiceIllegalArgumentException		if the address is null
	RiceIllegalStateException		if the address already exists in the system or address is not populated with entityId and entityTypeCode

Back to Operations

Method	updateAddress
Description	This will update a {@link org.kuali.rice.kim.api.identity.address.EntityAddress} exactly like the address passed in.
Parameters	EntityAddress	address	the EntityAddress to update
Return	EntityAddress		the updated EntityAddress object.
Errors	RiceIllegalArgumentException		if the address does not exist in the system.
	RiceIllegalStateException		???

Back to Operations

Method	inactivateAddress
Description	This will inactivate a {@link org.kuali.rice.kim.api.identity.address.EntityAddress} with the id passed in.
Parameters	String	id	the unique id of the EntityAddress to inactivate
Return	EntityAddress		the updated EntityAddress object.
Errors	RiceIllegalArgumentException		if the id is null
	RiceIllegalStateException		if the address does not exist in the system.

Back to Operations

Method	addEmailToEntity
Description	This will create a {@link org.kuali.rice.kim.api.identity.email.EntityEmail} exactly like the email passed in. The EntityEmail object passed in must be populated with an entityId and a entityTypeCode
Parameters	EntityEmail	email	the EntityEmail to create
Return	EntityEmail		the newly created EntityEmail object.
Errors	RiceIllegalArgumentException		if the email is null
	RiceIllegalStateException		if the email already exists in the system or email is not populated with entityId and entityTypeCode

Back to Operations

Method	updateEmail
Description	This will update a {@link org.kuali.rice.kim.api.identity.email.EntityEmail} exactly like the email passed in.
Parameters	EntityEmail	email	the EntityEmail to update
Return	EntityEmail		the updated EntityEmail object.
Errors	RiceIllegalArgumentException		if the email is null
	RiceIllegalStateException		if the email does not exist in the system.

Back to Operations

Method	inactivateEmail
Description	This will inactivate the {@link org.kuali.rice.kim.api.identity.email.EntityEmail} with the passed in id.
Parameters	String	id	the unique id of the EntityEmail to inactivate
Return	EntityEmail		the inactivated EntityEmail object.
Errors	RiceIllegalArgumentException		if the id is null
	RiceIllegalStateException		if the email does not exist in the system.

Back to Operations

Method	addPhoneToEntity
Description	This will create a {@link org.kuali.rice.kim.api.identity.phone.EntityPhone} exactly like the phone passed in. The EntityPhone object passed in must be populated with an entityId and a entityTypeCode
Parameters	EntityPhone	phone	the EntityPhone to create
Return	EntityPhone		the newly created EntityPhone object.
Errors	RiceIllegalArgumentException		if the phone is null
	RiceIllegalStateException		if the phone already exists in the system or phone is not populated with entityId and entityTypeCode

Back to Operations

Method	updatePhone
Description	This will update a {@link org.kuali.rice.kim.api.identity.phone.EntityPhone} exactly like the phone passed in.
Parameters	EntityPhone	phone	the EntityPhone to update
Return	EntityPhone		the updated EntityPhone object.
Errors	RiceIllegalArgumentException		if the phone is null
	RiceIllegalStateException		if the phone does not exist in the system.

Back to Operations

Method	inactivatePhone
Description	This will inactivate the {@link org.kuali.rice.kim.api.identity.phone.EntityPhone} with the passed in id.
Parameters	String	id	the unique id of the EntityPhone to inactivate
Return	EntityPhone		the inactivated EntityPhone object.
Errors	RiceIllegalArgumentException		if the id is null
	RiceIllegalStateException		if the phone does not exist in the system.

Back to Operations

Method	addExternalIdentifierToEntity
Description	This will create a {@link org.kuali.rice.kim.api.identity.external.EntityExternalIdentifier} exactly like the externalId passed in. The EntityExternalIdentifier object passed in must be populated with an entityId and a externalIdentifierTypeCode
Parameters	EntityExternalIdentifier	externalId	the EntityExternalIdentifier to create
Return	EntityExternalIdentifier		the newly created EntityExternalIdentifier object.
Errors	RiceIllegalArgumentException		if the externalId is null
	RiceIllegalStateException		if the externalId already exists in the system or externalId is not populated with entityId and externalIdentifierTypeCode

Back to Operations

Method	updateExternalIdentifier
Description	This will update a {@link org.kuali.rice.kim.api.identity.external.EntityExternalIdentifier} exactly like the externalId passed in.
Parameters	EntityExternalIdentifier	externalId	the EntityExternalIdentifier to update
Return	EntityExternalIdentifier		the updated EntityExternalIdentifier object.
Errors	RiceIllegalArgumentException		if the externalId is null
	RiceIllegalStateException		if the externalId does not exist in the system.

Back to Operations

Method	addAffiliationToEntity
Description	This will create a {@link org.kuali.rice.kim.api.identity.affiliation.EntityAffiliation} exactly like the affiliation passed in. The EntityAffiliation object passed in must be populated with an entityId and a affiliationType
Parameters	EntityAffiliation	affiliation	the EntityAffiliation to create
Return	EntityAffiliation		the newly created EntityAffiliation object.
Errors	RiceIllegalArgumentException		if the affiliation is null
	RiceIllegalStateException		if the affiliation already exists in the system or affiliation is not populated with entityId and affiliationType

Back to Operations

Method	updateAffiliation
Description	This will update a {@link org.kuali.rice.kim.api.identity.affiliation.EntityAffiliation} exactly like the affiliation passed in.
Parameters	EntityAffiliation	affiliation	the EntityAffiliation to update
Return	EntityAffiliation		the updated EntityAffiliation object.
Errors	RiceIllegalArgumentException		if the affiliation is null
	RiceIllegalStateException		if the affiliation does not exist in the system.

Back to Operations

Method	inactivateAffiliation
Description	This will inactivate a {@link org.kuali.rice.kim.api.identity.affiliation.EntityAffiliation} with the id passed in.
Parameters	String	id	the unique id of the EntityAffiliation to inactivate
Return	EntityAffiliation		the updated EntityAffiliation object.
Errors	RiceIllegalArgumentException		if the affiliation is null
	RiceIllegalStateException		if the affiliation does not exist in the system.

Back to Operations

Method	getDefaultNamesForPrincipalId
Description	This returns the display name information for the given principal without loading the full person object.
Parameters	String	principalId	The principal ID to find the name information for
Return	EntityNamePrincipalName		The default name information for the principal
Errors	NONE		No Errors

Back to Operations

Method	addNameToEntity
Description	This will create a {@link org.kuali.rice.kim.api.identity.name.EntityName} exactly like the name passed in. The EntityName object passed in must be populated with an entityId and a nameType
Parameters	EntityName	name	the EntityName to create
Return	EntityName		the newly created EntityName object.
Errors	RiceIllegalArgumentException		if the name is null
	RiceIllegalStateException		if the name already exists in the system or name is not populated with entityId and nameType

Back to Operations

Method	updateName
Description	This will update a {@link org.kuali.rice.kim.api.identity.name.EntityName} exactly like the name passed in.
Parameters	EntityName	name	the EntityName to update
Return	EntityName		the updated EntityName object.
Errors	RiceIllegalArgumentException		if the name is null
	RiceIllegalStateException		if the name does not exist in the system.

Back to Operations

Method	inactivateName
Description	This will inactivate a {@link org.kuali.rice.kim.api.identity.name.EntityName} with the passed in id.
Parameters	String	id	the unique id of the EntityName to inactivate
Return	EntityName		the inactivated EntityName object.
Errors	RiceIllegalArgumentException		if the id is null
	RiceIllegalStateException		if the name with the id does not exist in the system.

Back to Operations

Method	addEmploymentToEntity
Description	This will create a {@link org.kuali.rice.kim.api.identity.employment.EntityEmployment} exactly like the employment passed in. The EntityEmployment object passed in must be populated with an entityId and a employmentType
Parameters	EntityEmployment	employment	the EntityEmployment to create
Return	EntityEmployment		the newly created EntityName object.
Errors	RiceIllegalArgumentException		if the employment is null
	RiceIllegalStateException		if the employment already exists in the system or employment is not populated with entityId and employmentType

Back to Operations

Method	updateEmployment
Description	This will update a {@link org.kuali.rice.kim.api.identity.employment.EntityEmployment} exactly like the employment passed in.
Parameters	EntityEmployment	employment	the EntityEmployment to update
Return	EntityEmployment		the updated EntityEmployment object.
Errors	RiceIllegalArgumentException		if the employment is null
	RiceIllegalStateException		if the employment does not exist in the system.

Back to Operations

Method	inactivateEmployment
Description	This will inactivate a {@link org.kuali.rice.kim.api.identity.employment.EntityEmployment} with the passed in id.
Parameters	String	id	the unique id of the EntityEmployment to inactivate
Return	EntityEmployment		the inactivated EntityEmployment object.
Errors	RiceIllegalArgumentException		if the id is null
	RiceIllegalStateException		if the employment with the id does not exist in the system.

Back to Operations

Method	addBioDemographicsToEntity
Description	This will create a {@link org.kuali.rice.kim.api.identity.personal.EntityBioDemographics} exactly like the bioDemographics passed in. The EntityBioDemographics object passed in must be populated with an entityId
Parameters	EntityBioDemographics	bioDemographics	the EntityBioDemographics to create
Return	EntityBioDemographics		the newly created EntityBioDemographics object.
Errors	RiceIllegalArgumentException		if the bioDemographics is null
	RiceIllegalStateException		if the bioDemographics already exists in the system or bioDemographics is not populated with entityId

Back to Operations

Method	updateBioDemographics
Description	This will update a {@link org.kuali.rice.kim.api.identity.personal.EntityBioDemographics} exactly like the bioDemographics passed in.
Parameters	EntityBioDemographics	bioDemographics	the EntityBioDemographics to update
Return	EntityBioDemographics		the updated EntityBioDemographics object.
Errors	RiceIllegalArgumentException		if the bioDemographics is null
	RiceIllegalStateException		if the bioDemographics does not exist in the system.

Back to Operations

Method	getEntityPrivacyPreferences
Description	Gets a {@link org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences} for a given id. This method will return null if the EntityPrivacyPreferences does not exist.
Parameters	String	id	the unique id to retrieve the EntityPrivacyPreferences by. Cannot be null.
Return	EntityPrivacyPreferences		a {@link org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences} or null
Errors	RiceIllegalArgumentException		if the entityId is blank

Back to Operations

Method	addPrivacyPreferencesToEntity
Description	This will create a {@link org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences} exactly like the privacyPreferences passed in. The EntityPrivacyPreferences object passed in must be populated with an entityId
Parameters	EntityPrivacyPreferences	privacyPreferences	the EntityPrivacyPreferences to create
Return	EntityPrivacyPreferences		the newly created EntityPrivacyPreferences object.
Errors	RiceIllegalArgumentException		if the privacyPreferences is null
	RiceIllegalStateException		if the privacyPreferences already exists in the system or privacyPreferences is not populated with entityId

Back to Operations

Method	updatePrivacyPreferences
Description	This will update a {@link org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences} exactly like the privacyPreferences passed in.
Parameters	EntityPrivacyPreferences	privacyPreferences	the EntityPrivacyPreferences to update
Return	EntityPrivacyPreferences		the updated EntityPrivacyPreferences object.
Errors	RiceIllegalArgumentException		if the privacyPreferences is null
	RiceIllegalStateException		if the privacyPreferences does not exist in the system.

Back to Operations

Method	addCitizenshipToEntity
Description	This will create a {@link org.kuali.rice.kim.api.identity.citizenship.EntityCitizenship} exactly like the citizenship passed in. The EntityCitizenship object passed in must be populated with an entityId and a status
Parameters	EntityCitizenship	citizenship	the EntityCitizenship to create
Return	EntityCitizenship		the newly created EntityCitizenship object.
Errors	RiceIllegalArgumentException		if the citizenship is null
	RiceIllegalStateException		if the citizenship already exists in the system or citizenship is not populated with entityId and status

Back to Operations

Method	updateCitizenship
Description	This will update a {@link org.kuali.rice.kim.api.identity.citizenship.EntityCitizenship} exactly like the citizenship passed in.
Parameters	EntityCitizenship	citizenship	the EntityCitizenship to update
Return	EntityCitizenship		the updated EntityCitizenship object.
Errors	RiceIllegalArgumentException		if the citizenship is null
	RiceIllegalStateException		if the citizenship does not exist in the system.

Back to Operations

Method	inactivateCitizenship
Description	This will inactivate a {@link org.kuali.rice.kim.api.identity.citizenship.EntityCitizenship} with the unique id passed in.
Parameters	String	id	the id of the EntityCitizenship to inactivate
Return	EntityCitizenship		the inactivated EntityCitizenship object.
Errors	RiceIllegalArgumentException		if the citizenship is null
	RiceIllegalStateException		if the citizenship does not exist in the system.

Back to Operations

Method	addEthnicityToEntity
Description	This will create a {@link EntityEthnicity} exactly like the ethnicity passed in. The EntityEthnicity object passed in must be populated with an entityId and a ethnicity code
Parameters	EntityEthnicity	ethnicity	the EntityEthnicity to create
Return	EntityEthnicity		the newly created EntityEthnicity object.
Errors	RiceIllegalArgumentException		if the ethnicity is null
	RiceIllegalStateException		if the ethnicity already exists in the system or ethnicity is not populated with entityId and ethnicity code

Back to Operations

Method	updateEthnicity
Description	This will update a {@link EntityEthnicity} exactly like the ethnicity passed in.
Parameters	EntityEthnicity	ethnicity	the EntityEthnicity to update
Return	EntityEthnicity		the updated EntityEthnicity object.
Errors	RiceIllegalArgumentException		if the ethnicity is null
	RiceIllegalStateException		if the ethnicity does not exist in the system.

Back to Operations

Method	addResidencyToEntity
Description	This will create a {@link org.kuali.rice.kim.api.identity.residency.EntityResidency} exactly like the residency passed in. The EntityResidency object passed in must be populated with an entityId
Parameters	EntityResidency	residency	the EntityResidency to create
Return	EntityResidency		the newly created EntityResidency object.
Errors	RiceIllegalArgumentException		if the residency is null
	RiceIllegalStateException		if the residency already exists in the system or residency is not populated with entityId

Back to Operations

Method	updateResidency
Description	This will update a {@link org.kuali.rice.kim.api.identity.residency.EntityResidency} exactly like the residency passed in.
Parameters	EntityResidency	residency	the EntityResidency to update
Return	EntityResidency		the updated EntityResidency object.
Errors	RiceIllegalArgumentException		if the residency is null
	RiceIllegalStateException		if the residency does not exist in the system.

Back to Operations

Method	addVisaToEntity
Description	This will create a {@link org.kuali.rice.kim.api.identity.visa.EntityVisa} exactly like the visa passed in. The EntityVisa object passed in must be populated with an entityId and a visaTypeKey
Parameters	EntityVisa	visa	the EntityVisa to create
Return	EntityVisa		the newly created EntityVisa object.
Errors	RiceIllegalArgumentException		if the visa is null
	RiceIllegalStateException		if the visa already exists in the system or visa is not populated with entityId and a visaTypeKey

Back to Operations

Method	updateVisa
Description	This will update a {@link org.kuali.rice.kim.api.identity.visa.EntityVisa} exactly like the visa passed in.
Parameters	EntityVisa	visa	the EntityVisa to update
Return	EntityVisa		the updated EntityVisa object.
Errors	RiceIllegalArgumentException		if the visa is null
	RiceIllegalStateException		if the visa does not exist in the system.

Back to Operations

Method	getEntityType
Description	Gets the {@link org.kuali.rice.kim.api.identity.CodedAttribute} for a given EntityType code. This method will return null if the code does not exist.
Parameters	String	code	the unique id to retrieve the Type by. Cannot be null.
Return	CodedAttribute		a {@link org.kuali.rice.kim.api.identity.CodedAttribute} or null
Errors	RiceIllegalArgumentException		if the code is blank

Back to Operations

Method	findAllEntityTypes
Description	Finds all EntityTypes
Parameters	None	None	No Parameters
Return	CodedAttributeList		a list of {@link org.kuali.rice.kim.api.identity.CodedAttribute}
Errors	NONE		No Errors

Back to Operations

Method	getAddressType
Description	Gets the {@link org.kuali.rice.kim.api.identity.CodedAttribute} for a given EntityAddressType code. This method will return null if the code does not exist.
Parameters	String	code	the unique id to retrieve the Type by. Cannot be null.
Return	CodedAttribute		a {@link org.kuali.rice.kim.api.identity.CodedAttribute} or null
Errors	RiceIllegalArgumentException		if the code is blank

Back to Operations

Method	findAllAddressTypes
Description	Finds all EntityAddressTypes
Parameters	None	None	No Parameters
Return	CodedAttributeList		a list of {@link org.kuali.rice.kim.api.identity.CodedAttribute}
Errors	NONE		No Errors

Back to Operations

Method	getAffiliationType
Description	Gets the {@link org.kuali.rice.kim.api.identity.affiliation.EntityAffiliationType} for a given EntityAffiliationType code. This method will return null if the code does not exist.
Parameters	String	code	the unique id to retrieve the EntityAffiliationType by. Cannot be null.
Return	EntityAffiliationType		a {@link org.kuali.rice.kim.api.identity.affiliation.EntityAffiliationType} or null
Errors	RiceIllegalArgumentException		if the code is blank

Back to Operations

Method	findAllAffiliationTypes
Description	Finds all EntityAffiliationTypes
Parameters	None	None	No Parameters
Return	EntityAffiliationTypeList		a list of {@link org.kuali.rice.kim.api.identity.affiliation.EntityAffiliationType}
Errors	NONE		No Errors

Back to Operations

Method	getCitizenshipStatus
Description	Gets the {@link org.kuali.rice.kim.api.identity.CodedAttribute} for a given EntityCitizenship status code. This method will return null if the code does not exist.
Parameters	String	code	the unique id to retrieve the Type by. Cannot be null.
Return	CodedAttribute		a {@link org.kuali.rice.kim.api.identity.CodedAttribute} or null
Errors	RiceIllegalArgumentException		if the code is blank

Back to Operations

Method	findAllCitizenshipStatuses
Description	Finds all EntityCitizenshipStatuses
Parameters	None	None	No Parameters
Return	CodedAttributeList		a list of {@link org.kuali.rice.kim.api.identity.CodedAttribute}
Errors	NONE		No Errors

Back to Operations

Method	getEmploymentType
Description	Gets the {@link org.kuali.rice.kim.api.identity.CodedAttribute} for a given EntityEmployment type code. This method will return null if the code does not exist.
Parameters	String	code	the unique id to retrieve the Type by. Cannot be null.
Return	CodedAttribute		a {@link org.kuali.rice.kim.api.identity.CodedAttribute} or null
Errors	RiceIllegalArgumentException		if the code is blank

Back to Operations

Method	findAllEmploymentTypes
Description	Finds all EntityEmploymentTypes
Parameters	None	None	No Parameters
Return	CodedAttributeList		a list of {@link org.kuali.rice.kim.api.identity.CodedAttribute}
Errors	NONE		No Errors

Back to Operations

Method	getEmploymentStatus
Description	Gets the {@link org.kuali.rice.kim.api.identity.CodedAttribute} for a given EntityEmployment status code. This method will return null if the code does not exist.
Parameters	String	code	the unique id to retrieve the Type by. Cannot be null.
Return	CodedAttribute		a {@link org.kuali.rice.kim.api.identity.CodedAttribute} or null
Errors	RiceIllegalArgumentException		if the code is blank

Back to Operations

Method	findAllEmploymentStatuses
Description	Finds all EntityEmploymentStatuses
Parameters	None	None	No Parameters
Return	CodedAttributeList		a list of {@link org.kuali.rice.kim.api.identity.CodedAttribute}
Errors	NONE		No Errors

Back to Operations

Method	getExternalIdentifierType
Description	Gets the {@link org.kuali.rice.kim.api.identity.external.EntityExternalIdentifierType} for a given type code. This method will return null if the code does not exist.
Parameters	String	code	the unique id to retrieve the EntityExternalIdentifierType by. Cannot be null.
Return	EntityExternalIdentifierType		a {@link org.kuali.rice.kim.api.identity.CodedAttribute} or null
Errors	RiceIllegalArgumentException		if the code is blank

Back to Operations

Method	findAllExternalIdendtifierTypes
Description	Finds all ExternalIdentifierTypes
Parameters	None	None	No Parameters
Return	EntityExternalIdentifierTypeList		a list of {@link org.kuali.rice.kim.api.identity.external.EntityExternalIdentifierType}
Errors	NONE		No Errors

Back to Operations

Method	getNameType
Description	Gets the {@link org.kuali.rice.kim.api.identity.CodedAttribute} for a given EntityName type code. This method will return null if the code does not exist.
Parameters	String	code	the unique id to retrieve the Type by. Cannot be null.
Return	CodedAttribute		a {@link org.kuali.rice.kim.api.identity.CodedAttribute} or null
Errors	RiceIllegalArgumentException		if the code is blank

Back to Operations

Method	findAllNameTypes
Description	Finds all EntityNameTypes
Parameters	None	None	No Parameters
Return	CodedAttributeList		a list of {@link org.kuali.rice.kim.api.identity.CodedAttribute}
Errors	NONE		No Errors

Back to Operations

Method	getPhoneType
Description	Gets the {@link org.kuali.rice.kim.api.identity.CodedAttribute} for a given EntityPhone type code. This method will return null if the code does not exist.
Parameters	String	code	the unique id to retrieve the Type by. Cannot be null.
Return	CodedAttribute		a {@link org.kuali.rice.kim.api.identity.CodedAttribute} or null
Errors	RiceIllegalArgumentException		if the code is blank

Back to Operations

Method	findAllPhoneTypes
Description	Finds all EntityPhoneTypes
Parameters	None	None	No Parameters
Return	CodedAttributeList		a list of {@link org.kuali.rice.kim.api.identity.CodedAttribute}
Errors	NONE		No Errors

Back to Operations

Method	getEmailType
Description	Gets the {@link org.kuali.rice.kim.api.identity.CodedAttribute} for a given EntityEmail type code. This method will return null if the code does not exist.
Parameters	String	code	the unique id to retrieve the Type by. Cannot be null.
Return	CodedAttribute		a {@link org.kuali.rice.kim.api.identity.CodedAttribute} or null
Errors	RiceIllegalArgumentException		if the code is blank

Back to Operations

Method	findAllEmailTypes
Description	Finds all EntityEmailTypes
Parameters	None	None	No Parameters
Return	CodedAttributeList		a list of {@link org.kuali.rice.kim.api.identity.CodedAttribute}
Errors	NONE		No Errors

Back to Operations

Method	findPrincipals
Description	This method finds Principals based on a query criteria. The criteria cannot be null.
Parameters	QueryByCriteria	query	the criteria. Cannot be null.
Return	PrincipalQueryResults		query results. will never return null.
Errors	RiceIllegalArgumentException		???

Back to Operations