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

Interface IdentityService

public interface IdentityService
This service provides operations to query for principal and identity data.

A principal represents an identity that can authenticate. In essence, a principal can be thought of as an "account" or as an identity's authentication credentials. A principal has an id which is used to uniquely identify it. It also has a name which represents the principal's username and is typically what is entered when authenticating. All principals are associated with one and only one identity.

An identity represents a person or system. Additionally, other "types" of entities can be defined in KIM. Information like name, phone number, etc. is associated with an identity. It is the representation of a concrete person or system. While an identity will typically have a single principal associated with it, it is possible for an identity to have more than one principal or even no principals at all (in the case where the identity does not actually authenticate).

This service also provides operations for querying various pieces of reference data, such as address types, affiliation types, phone types, etc.

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

  • Method Details

    • findEntityDefaults

      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

      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

      @Cacheable(value="http://rice.kuali.org/kim/v2_0/EntityType", key="\'id=\' + #p0") 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") 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") 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") 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) Entity createEntity(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) Entity updateEntity(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) 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") 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") 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") 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") 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") 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<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<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<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") 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") 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) Principal addPrincipalToEntity(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) Principal updatePrincipal(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) 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) 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) EntityTypeContactInfo addEntityTypeContactInfoToEntity(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) EntityTypeContactInfo updateEntityTypeContactInfo(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) 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) EntityAddress addAddressToEntity(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) EntityAddress updateAddress(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) 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) EntityEmail addEmailToEntity(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) EntityEmail updateEmail(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) 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) EntityPhone addPhoneToEntity(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) EntityPhone updatePhone(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) 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) EntityExternalIdentifier addExternalIdentifierToEntity(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) EntityExternalIdentifier updateExternalIdentifier(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) EntityAffiliation addAffiliationToEntity(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) EntityAffiliation updateAffiliation(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) 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") 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

    • getDefaultNamesForPrincipalIds

      Map<String,EntityNamePrincipalName> getDefaultNamesForPrincipalIds(List<String> principalIds)
      This returns the display name information for the given principals without loading the full person object.
      Parameters:
      principalIds - A list of principal IDs to find the name information for
      Returns:
      A Map which is keyed by principal ID and the value is the default name for that principal. If an active, default name cannot be found for a principal in the list it will be in the map with a null value.

    • getPrivacyPreferencesForPrincipalId

      @Cacheable(value="http://rice.kuali.org/kim/v2_0/EntityPrivacyPreferencesType", key="\'principalId=\' + #p0") EntityPrivacyPreferences getPrivacyPreferencesForPrincipalId(String principalId)
      Returns the privacy preferences for the given principal id or null if the principal id is not valid. Note method converts list to a HashSet to ensure no duplicate look ups occur.
      Parameters:
      principalId - the principal id
      Returns:
      The privacy preferences for the given principal id, or null if the principal id is invalid.

    • 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) EntityName addNameToEntity(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) EntityName updateName(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) 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) EntityEmployment addEmploymentToEntity(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) EntityEmployment updateEmployment(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) 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) EntityBioDemographics addBioDemographicsToEntity(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) EntityBioDemographics updateBioDemographics(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") 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) EntityPrivacyPreferences addPrivacyPreferencesToEntity(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) EntityPrivacyPreferences updatePrivacyPreferences(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) EntityCitizenship addCitizenshipToEntity(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) EntityCitizenship updateCitizenship(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) 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) EntityEthnicity addEthnicityToEntity(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) EntityEthnicity updateEthnicity(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) EntityResidency addResidencyToEntity(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) EntityResidency updateResidency(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) EntityVisa addVisaToEntity(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) EntityVisa updateVisa(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") 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<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") 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<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") 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<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") 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<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") 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<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") 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<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") 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<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") 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<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") 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<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") 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<CodedAttribute> findAllEmailTypes()
      Finds all EntityEmailTypes
      Returns:
      a list of CodedAttribute
      Since:
      2.0.1

    • findPrincipals

      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