IdentityServiceImpl (Rice 2.5.5-SNAPSHOT API)

java.lang.Object
- org.kuali.rice.kim.impl.identity.IdentityServiceImpl

All Implemented Interfaces:

IdentityService

Direct Known Subclasses:

LdapIdentityDelegateServiceImpl
```
public class IdentityServiceImpl
extends Object
implements IdentityService
```
Base implementation of the identity (identity) service. This version assumes the KimEntity and related data is located within the KIM database.

Author:

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

Field Summary

Fields
Modifier and Type Field and Description

protected DataObjectService dataObjectService

protected IdentityServiceDao identityServiceDao

protected static String UNAVAILABLE

Fields
Modifier and Type	Field and Description
`protected DataObjectService`	`dataObjectService`
`protected IdentityServiceDao`	`identityServiceDao`
`protected static String`	`UNAVAILABLE`

Constructor Summary

Constructors
Constructor and Description

IdentityServiceImpl()

Constructors
Constructor and Description
`IdentityServiceImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`EntityAddress`	`addAddressToEntity(EntityAddress address)` This will create a `EntityAddress` exactly like the address passed in.
`EntityAffiliation`	`addAffiliationToEntity(EntityAffiliation affiliation)` This will create a `EntityAffiliation` exactly like the affiliation passed in.
`EntityBioDemographics`	`addBioDemographicsToEntity(EntityBioDemographics bioDemographics)` This will create a `EntityBioDemographics` exactly like the bioDemographics passed in.
`EntityCitizenship`	`addCitizenshipToEntity(EntityCitizenship citizenship)` This will create a `EntityCitizenship` exactly like the citizenship passed in.
`EntityEmail`	`addEmailToEntity(EntityEmail email)` This will create a `EntityEmail` exactly like the email passed in.
`EntityEmployment`	`addEmploymentToEntity(EntityEmployment employment)` This will create a `EntityEmployment` exactly like the employment passed in.
`EntityTypeContactInfo`	`addEntityTypeContactInfoToEntity(EntityTypeContactInfo entityTypeData)` This will create a `EntityTypeContactInfo` exactly like the entityTypeContactInfo passed in.
`EntityEthnicity`	`addEthnicityToEntity(EntityEthnicity ethnicity)` This will create a `EntityEthnicity` exactly like the ethnicity passed in.
`EntityExternalIdentifier`	`addExternalIdentifierToEntity(EntityExternalIdentifier externalId)` This will create a `EntityExternalIdentifier` exactly like the externalId passed in.
`EntityName`	`addNameToEntity(EntityName name)` This will create a `EntityName` exactly like the name passed in.
`EntityPhone`	`addPhoneToEntity(EntityPhone phone)` This will create a `EntityPhone` exactly like the phone passed in.
`Principal`	`addPrincipalToEntity(Principal principal)` This will create a `Principal` exactly like the principal passed in.
`EntityPrivacyPreferences`	`addPrivacyPreferencesToEntity(EntityPrivacyPreferences privacyPreferences)` This will create a `EntityPrivacyPreferences` exactly like the privacyPreferences passed in.
`EntityResidency`	`addResidencyToEntity(EntityResidency residency)` This will create a `EntityResidency` exactly like the residency passed in.
`EntityVisa`	`addVisaToEntity(EntityVisa visa)` This will create a `EntityVisa` exactly like the visa passed in.
`Entity`	`createEntity(Entity entity)` This will create a `Entity` exactly like the entity passed in.
`List<CodedAttribute>`	`findAllAddressTypes()` Finds all EntityAddressTypes
`List<EntityAffiliationType>`	`findAllAffiliationTypes()` Finds all EntityAffiliationTypes
`List<CodedAttribute>`	`findAllCitizenshipStatuses()` Finds all EntityCitizenshipStatuses
`List<CodedAttribute>`	`findAllEmailTypes()` Finds all EntityEmailTypes
`List<CodedAttribute>`	`findAllEmploymentStatuses()` Finds all EntityEmploymentStatuses
`List<CodedAttribute>`	`findAllEmploymentTypes()` Finds all EntityEmploymentTypes
`List<CodedAttribute>`	`findAllEntityTypes()` Finds all EntityTypes
`List<EntityExternalIdentifierType>`	`findAllExternalIdendtifierTypes()` Finds all ExternalIdentifierTypes
`List<CodedAttribute>`	`findAllNameTypes()` Finds all EntityNameTypes
`List<CodedAttribute>`	`findAllPhoneTypes()` Finds all EntityPhoneTypes
`EntityQueryResults`	`findEntities(QueryByCriteria queryByCriteria)` This method finds Entities based on a query criteria.
`EntityDefaultQueryResults`	`findEntityDefaults(QueryByCriteria queryByCriteria)` This method finds EntityDefault data based on a query criteria.
`protected EntityNameQueryResults`	`findNames(QueryByCriteria queryByCriteria)`
`PrincipalQueryResults`	`findPrincipals(QueryByCriteria query)` This method finds Principals based on a query criteria.
`CodedAttribute`	`getAddressType(String code)` Gets the `CodedAttribute` for a given EntityAddressType code.
`EntityAffiliationType`	`getAffiliationType(String code)` Gets the `EntityAffiliationType` for a given EntityAffiliationType code.
`CodedAttribute`	`getCitizenshipStatus(String code)` Gets the `CodedAttribute` for a given EntityCitizenship status code.
`EntityNamePrincipalName`	`getDefaultNamesForPrincipalId(String principalId)` This returns the display name information for the given principal without loading the full person object.
`Map<String,EntityNamePrincipalName>`	`getDefaultNamesForPrincipalIds(List<String> principalIds)` This returns the display name information for the given principals without loading the full person object.
`CodedAttribute`	`getEmailType(String code)` Gets the `CodedAttribute` for a given EntityEmail type code.
`CodedAttribute`	`getEmploymentStatus(String code)` Gets the `CodedAttribute` for a given EntityEmployment status code.
`CodedAttribute`	`getEmploymentType(String code)` Gets the `CodedAttribute` for a given EntityEmployment type code.
`Entity`	`getEntity(String entityId)` Gets a `Entity` from an id.
`protected EntityAddressBo`	`getEntityAddressBo(String addressId)`
`protected EntityAddressBo`	`getEntityAddressBo(String entityId, String entityTypeCode, String addressTypeCode)`
`protected EntityAffiliationBo`	`getEntityAffiliationBo(String id)`
`protected EntityBioDemographicsBo`	`getEntityBioDemographicsBo(String entityId)`
`protected EntityBo`	`getEntityBo(String entityId)`
`protected EntityBo`	`getEntityBoByEmployeeId(String employeeId)`
`protected EntityBo`	`getEntityBoByPrincipalId(String principalId)`
`protected EntityBo`	`getEntityBoByPrincipalName(String principalName)`
`Entity`	`getEntityByEmployeeId(String employeeId)` Gets a `Entity` from a employeeId.
`protected EntityBo`	`getEntityByKeyValue(String key, String value)` Generic helper method for performing a lookup through the business object service.
`Entity`	`getEntityByPrincipalId(String principalId)` Gets a `Entity` from a principalId.
`Entity`	`getEntityByPrincipalName(String principalName)` Gets a `Entity` from a principalName.
`protected EntityCitizenshipBo`	`getEntityCitizenshipBo(String id)`
`protected EntityCitizenshipBo`	`getEntityCitizenshipBo(String entityId, String citizenshipStatusCode)`
`EntityDefault`	`getEntityDefault(String entityId)` Gets a `EntityDefault` from an id.
`EntityDefault`	`getEntityDefaultByEmployeeId(String employeeId)` Gets a `EntityDefault` from an employeeId.
`EntityDefault`	`getEntityDefaultByPrincipalId(String principalId)` Gets a `EntityDefault` from an principalId.
`EntityDefault`	`getEntityDefaultByPrincipalName(String principalName)` Gets a `EntityDefault` from an principalName.
`protected EntityEmailBo`	`getEntityEmailBo(String emailId)`
`protected EntityEmailBo`	`getEntityEmailBo(String entityId, String entityTypeCode, String emailTypeCode)`
`protected EntityEmploymentBo`	`getEntityEmploymentBo(String id)`
`protected EntityEmploymentBo`	`getEntityEmploymentBo(String entityId, String employmentTypeCode, String employmentStatusCode, String employmentAffiliationId)`
`protected EntityEthnicityBo`	`getEntityEthnicityBo(String ethnicityId)`
`protected EntityExternalIdentifierBo`	`getEntityExternalIdentifierBo(String entityId, String externalIdentifierTypeCode)`
`protected EntityNameBo`	`getEntityNameBo(String id)`
`protected EntityNameBo`	`getEntityNameBo(String entityId, String nameTypeCode)`
`protected EntityPhoneBo`	`getEntityPhoneBo(String phoneId)`
`protected EntityPhoneBo`	`getEntityPhoneBo(String entityId, String entityTypeCode, String phoneTypeCode)`
`EntityPrivacyPreferences`	`getEntityPrivacyPreferences(String entityId)` Gets a `EntityPrivacyPreferences` for a given id.
`protected EntityResidencyBo`	`getEntityResidencyBo(String residencyId)`
`CodedAttribute`	`getEntityType(String code)` Gets the `CodedAttribute` for a given EntityType code.
`protected EntityTypeContactInfoBo`	`getEntityTypeDataBo(String entityId, String entityTypeCode)`
`protected EntityVisaBo`	`getEntityVisaBo(String visaId)`
`EntityExternalIdentifierType`	`getExternalIdentifierType(String code)` Gets the `EntityExternalIdentifierType` for a given type code.
`IdentityServiceDao`	`getIdentityServiceDao()`
`CodedAttribute`	`getNameType(String code)` Gets the `CodedAttribute` for a given EntityName type code.
`CodedAttribute`	`getPhoneType(String code)` Gets the `CodedAttribute` for a given EntityPhone type code.
`Principal`	`getPrincipal(String principalId)` Gets a `Principal` from an principalId.
`protected PrincipalBo`	`getPrincipalBo(String principalId)`
`protected PrincipalBo`	`getPrincipalBoByPrincipalName(String principalName)`
`Principal`	`getPrincipalByPrincipalName(String principalName)` Gets a `Principal` from an principalName.
`Principal`	`getPrincipalByPrincipalNameAndPassword(String principalName, String password)` Gets a `Principal` from an principalName and password.
`List<Principal>`	`getPrincipals(List<String> principalIds)` Gets a list of `Principal` from a string list of principalId.
`List<Principal>`	`getPrincipalsByEmployeeId(String employeeId)` Gets a list of `Principal` from an employeeId
`List<Principal>`	`getPrincipalsByEntityId(String entityId)` Gets a list of `Principal` from an entityId.
`EntityPrivacyPreferences`	`getPrivacyPreferencesForPrincipalId(String principalId)` Returns the privacy preferences for the given principal id or null if the principal id is not valid.
`EntityAddress`	`inactivateAddress(String addressId)` This will inactivate a `EntityAddress` with the id passed in.
`EntityAffiliation`	`inactivateAffiliation(String id)` This will inactivate a `EntityAffiliation` with the id passed in.
`EntityCitizenship`	`inactivateCitizenship(String id)` This will inactivate a `EntityCitizenship` with the unique id passed in.
`EntityEmail`	`inactivateEmail(String emailId)` This will inactivate the `EntityEmail` with the passed in id.
`EntityEmployment`	`inactivateEmployment(String id)` This will inactivate a `EntityEmployment` with the passed in id.
`Entity`	`inactivateEntity(String entityId)` This will inactivate a `Entity`.
`EntityTypeContactInfo`	`inactivateEntityTypeContactInfo(String entityId, String entityTypeCode)` This will inactivate a `EntityTypeContactInfo` with the passed in parameters.
`EntityName`	`inactivateName(String id)` This will inactivate a `EntityName` with the passed in id.
`EntityPhone`	`inactivatePhone(String phoneId)` This will inactivate the `EntityPhone` with the passed in id.
`Principal`	`inactivatePrincipal(String principalId)` This will inactivate a `Principal`.
`Principal`	`inactivatePrincipalByName(String principalName)` This will inactivate a `Principal`.
`protected void`	`incomingParamCheck(Object object, String name)`
`void`	`setDataObjectService(DataObjectService dataObjectService)`
`void`	`setIdentityServiceDao(IdentityServiceDao identityServiceDao)`
`EntityAddress`	`updateAddress(EntityAddress address)` This will update a `EntityAddress` exactly like the address passed in.
`EntityAffiliation`	`updateAffiliation(EntityAffiliation affiliation)` This will update a `EntityAffiliation` exactly like the affiliation passed in.
`EntityBioDemographics`	`updateBioDemographics(EntityBioDemographics bioDemographics)` This will update a `EntityBioDemographics` exactly like the bioDemographics passed in.
`EntityCitizenship`	`updateCitizenship(EntityCitizenship citizenship)` This will update a `EntityCitizenship` exactly like the citizenship passed in.
`EntityEmail`	`updateEmail(EntityEmail email)` This will update a `EntityEmail` exactly like the email passed in.
`EntityEmployment`	`updateEmployment(EntityEmployment employment)` This will update a `EntityEmployment` exactly like the employment passed in.
`Entity`	`updateEntity(Entity entity)` This will update a `Entity`.
`EntityTypeContactInfo`	`updateEntityTypeContactInfo(EntityTypeContactInfo entityTypeContactInfo)` This will update a `EntityTypeContactInfo` exactly like the entityTypeContactInfo passed in.
`EntityEthnicity`	`updateEthnicity(EntityEthnicity ethnicity)` This will update a `EntityEthnicity` exactly like the ethnicity passed in.
`EntityExternalIdentifier`	`updateExternalIdentifier(EntityExternalIdentifier externalId)` This will update a `EntityExternalIdentifier` exactly like the externalId passed in.
`EntityName`	`updateName(EntityName name)` This will update a `EntityName` exactly like the name passed in.
`EntityPhone`	`updatePhone(EntityPhone phone)` This will update a `EntityPhone` exactly like the phone passed in.
`Principal`	`updatePrincipal(Principal principal)` This will update a `Principal` exactly like the principal passed in.
`EntityPrivacyPreferences`	`updatePrivacyPreferences(EntityPrivacyPreferences privacyPreferences)` This will update a `EntityPrivacyPreferences` exactly like the privacyPreferences passed in.
`EntityResidency`	`updateResidency(EntityResidency residency)` This will update a `EntityResidency` exactly like the residency passed in.
`EntityVisa`	`updateVisa(EntityVisa visa)` This will update a `EntityVisa` exactly like the visa passed in.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UNAVAILABLE
```
protected static final String UNAVAILABLE
```
    See Also:
    Constant Field Values
  - dataObjectService
```
protected DataObjectService dataObjectService
```
  - identityServiceDao
```
protected IdentityServiceDao identityServiceDao
```
- Constructor Detail
  - IdentityServiceImpl
```
public IdentityServiceImpl()
```
- Method Detail
  - getEntity
```
public Entity getEntity(String entityId)
                 throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets a Entity from an id.
    This method will return null if the Entity does not exist.
    
    Specified by:
    
    getEntity in interface IdentityService
    
    Parameters:
    entityId - the unique id to retrieve the entity by. cannot be null.
    
    Returns:
    a Entity or null
    
    Throws:
    
    RiceIllegalArgumentException - if the id is blank
  - getEntityByPrincipalId
```
public Entity getEntityByPrincipalId(String principalId)
                              throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets a Entity from a principalId.
    This method will return null if the Entity does not exist.
    
    Specified by:
    
    getEntityByPrincipalId in interface IdentityService
    
    Parameters:
    principalId - the unique id to retrieve the entity by. cannot be null.
    
    Returns:
    a Entity or null
    
    Throws:
    
    RiceIllegalArgumentException - if the principalId is blank
  - getEntityByPrincipalName
```
public Entity getEntityByPrincipalName(String principalName)
                                throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets a Entity from a principalName.
    This method will return null if the Entity does not exist.
    
    Specified by:
    
    getEntityByPrincipalName in interface IdentityService
    
    Parameters:
    principalName - the unique id to retrieve the entity by. cannot be null.
    
    Returns:
    a Entity or null
    
    Throws:
    
    RiceIllegalArgumentException - if the id is blank
  - getEntityByEmployeeId
```
public Entity getEntityByEmployeeId(String employeeId)
                             throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets a Entity from a employeeId.
    This method will return null if the Entity does not exist.
    
    Specified by:
    
    getEntityByEmployeeId in interface IdentityService
    
    Parameters:
    employeeId - the unique id to retrieve the entity by. cannot be null.
    
    Returns:
    a Entity or null
    
    Throws:
    
    RiceIllegalArgumentException - if the employeeId is blank
  - getEntityDefault
```
public EntityDefault getEntityDefault(String entityId)
                               throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    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.
    
    Specified by:
    
    getEntityDefault in interface IdentityService
    
    Parameters:
    entityId - the unique id to retrieve the entity by. cannot be null.
    
    Returns:
    a EntityDefault or null
    
    Throws:
    
    RiceIllegalArgumentException - if the id is blank
  - getEntityDefaultByPrincipalId
```
public EntityDefault getEntityDefaultByPrincipalId(String principalId)
                                            throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    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.
    
    Specified by:
    
    getEntityDefaultByPrincipalId in interface IdentityService
    
    Parameters:
    principalId - the unique id to retrieve the entity by. cannot be null.
    
    Returns:
    a EntityDefault or null
    
    Throws:
    
    RiceIllegalArgumentException - if the principalId is blank
  - getEntityDefaultByPrincipalName
```
public EntityDefault getEntityDefaultByPrincipalName(String principalName)
                                              throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    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.
    
    Specified by:
    
    getEntityDefaultByPrincipalName in interface IdentityService
    
    Parameters:
    principalName - the unique id to retrieve the entity by. cannot be null.
    
    Returns:
    a EntityDefault or null
    
    Throws:
    
    RiceIllegalArgumentException - if the principalId is blank
  - getEntityDefaultByEmployeeId
```
public EntityDefault getEntityDefaultByEmployeeId(String employeeId)
                                           throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    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.
    
    Specified by:
    
    getEntityDefaultByEmployeeId in interface IdentityService
    
    Parameters:
    employeeId - the unique id to retrieve the entity by. cannot be null.
    
    Returns:
    a EntityDefault or null
    
    Throws:
    
    RiceIllegalArgumentException - if the employeeId is blank
  - getPrincipalByPrincipalNameAndPassword
```
public Principal getPrincipalByPrincipalNameAndPassword(String principalName,
                                               String password)
                                                 throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets a Principal from an principalName and password.
    This method will return null if the Principal does not exist or the password is incorrect.
    
    Specified by:
    
    getPrincipalByPrincipalNameAndPassword in interface IdentityService
    
    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:
    
    RiceIllegalArgumentException - if the principalName is blank
  - addPrincipalToEntity
```
public Principal addPrincipalToEntity(Principal principal)
                               throws RiceIllegalArgumentException,
                                      RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    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
    
    Specified by:
    
    addPrincipalToEntity in interface IdentityService
    
    Parameters:
    principal - the principal to create
    
    Returns:
    the newly created Principal object.
    
    Throws:
    
    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
  - updatePrincipal
```
public Principal updatePrincipal(Principal principal)
                          throws RiceIllegalArgumentException,
                                 RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will update a Principal exactly like the principal passed in.
    
    Specified by:
    
    updatePrincipal in interface IdentityService
    
    Parameters:
    principal - the principal to update
    
    Returns:
    the updated Principal object.
    
    Throws:
    
    RiceIllegalArgumentException - if the principal is null
    
    RiceIllegalStateException - if the principal does not exist in the system.
  - inactivatePrincipal
```
public Principal inactivatePrincipal(String principalId)
                              throws RiceIllegalArgumentException,
                                     RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will inactivate a Principal.
    
    Specified by:
    
    inactivatePrincipal in interface IdentityService
    
    Parameters:
    principalId - the unique id of the principal to inactivate
    
    Returns:
    the inactivated Principal object.
    
    Throws:
    
    RiceIllegalArgumentException - if the principal is null
    
    RiceIllegalStateException - if the principal does not exist in the system.
  - inactivatePrincipalByName
```
public Principal inactivatePrincipalByName(String principalName)
                                    throws RiceIllegalArgumentException,
                                           RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will inactivate a Principal.
    
    Specified by:
    
    inactivatePrincipalByName in interface IdentityService
    
    Parameters:
    principalName - the unique principalName of the principal to inactivate
    
    Returns:
    the inactivated Principal object.
    
    Throws:
    
    RiceIllegalArgumentException - if the principal is null
    
    RiceIllegalStateException - if the principal does not exist in the system.
  - addEntityTypeContactInfoToEntity
```
public EntityTypeContactInfo addEntityTypeContactInfoToEntity(EntityTypeContactInfo entityTypeData)
                                                       throws RiceIllegalArgumentException,
                                                              RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    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
    
    Specified by:
    
    addEntityTypeContactInfoToEntity in interface IdentityService
    
    Parameters:
    entityTypeData - the EntityTypeContactInfo to create
    
    Returns:
    the newly created EntityTypeContactInfo object.
    
    Throws:
    
    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
  - getEntityTypeDataBo
```
protected EntityTypeContactInfoBo getEntityTypeDataBo(String entityId,
                                          String entityTypeCode)
```
  - updateEntityTypeContactInfo
```
public EntityTypeContactInfo updateEntityTypeContactInfo(EntityTypeContactInfo entityTypeContactInfo)
                                                  throws RiceIllegalArgumentException,
                                                         RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will update a EntityTypeContactInfo exactly like the entityTypeContactInfo passed in.
    
    Specified by:
    
    updateEntityTypeContactInfo in interface IdentityService
    
    Parameters:
    entityTypeContactInfo - the EntityTypeContactInfo to update
    
    Returns:
    the updated EntityTypeContactInfo object.
    
    Throws:
    
    RiceIllegalArgumentException - if the entityTypeContactInfo is null
    
    RiceIllegalStateException - if the entityTypeContactInfo does not exist in the system.
  - inactivateEntityTypeContactInfo
```
public EntityTypeContactInfo inactivateEntityTypeContactInfo(String entityId,
                                                    String entityTypeCode)
                                                      throws RiceIllegalArgumentException,
                                                             RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will inactivate a EntityTypeContactInfo with the passed in parameters.
    
    Specified by:
    
    inactivateEntityTypeContactInfo in interface IdentityService
    
    Parameters:
    entityId - the entityId of the EntityTypeContactInfo to inactivate
    entityTypeCode - the entityTypeCode of the EntityTypeContactInfo to inactivate
    
    Returns:
    the inactivated EntityTypeContactInfo object.
    
    Throws:
    
    RiceIllegalArgumentException - if the entityId or entityTypeCode passed in is null
    
    RiceIllegalStateException - if the EntityTypeContactInfo does not exist in the system.
  - getEntityAddressBo
```
protected EntityAddressBo getEntityAddressBo(String entityId,
                                 String entityTypeCode,
                                 String addressTypeCode)
```
  - getEntityAddressBo
```
protected EntityAddressBo getEntityAddressBo(String addressId)
```
  - addAddressToEntity
```
public EntityAddress addAddressToEntity(EntityAddress address)
                                 throws RiceIllegalArgumentException,
                                        RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    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
    
    Specified by:
    
    addAddressToEntity in interface IdentityService
    
    Parameters:
    address - the EntityAddress to create
    
    Returns:
    the newly created EntityAddress object.
    
    Throws:
    
    RiceIllegalArgumentException - if the address is null
    
    RiceIllegalStateException - if the address already exists in the system or address is not populated with entityId and entityTypeCode
  - updateAddress
```
public EntityAddress updateAddress(EntityAddress address)
                            throws RiceIllegalArgumentException,
                                   RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will update a EntityAddress exactly like the address passed in.
    
    Specified by:
    
    updateAddress in interface IdentityService
    
    Parameters:
    address - the EntityAddress to update
    
    Returns:
    the updated EntityAddress object.
    
    Throws:
    
    RiceIllegalArgumentException - if the address does not exist in the system.
    
    RiceIllegalStateException
  - inactivateAddress
```
public EntityAddress inactivateAddress(String addressId)
                                throws RiceIllegalArgumentException,
                                       RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will inactivate a EntityAddress with the id passed in.
    
    Specified by:
    
    inactivateAddress in interface IdentityService
    
    Parameters:
    addressId - the unique id of the EntityAddress to inactivate
    
    Returns:
    the updated EntityAddress object.
    
    Throws:
    
    RiceIllegalArgumentException - if the id is null
    
    RiceIllegalStateException - if the address does not exist in the system.
  - getEntityEmailBo
```
protected EntityEmailBo getEntityEmailBo(String entityId,
                             String entityTypeCode,
                             String emailTypeCode)
```
  - getEntityEmailBo
```
protected EntityEmailBo getEntityEmailBo(String emailId)
```
  - addEmailToEntity
```
public EntityEmail addEmailToEntity(EntityEmail email)
                             throws RiceIllegalArgumentException,
                                    RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    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
    
    Specified by:
    
    addEmailToEntity in interface IdentityService
    
    Parameters:
    email - the EntityEmail to create
    
    Returns:
    the newly created EntityEmail object.
    
    Throws:
    
    RiceIllegalArgumentException - if the email is null
    
    RiceIllegalStateException - if the email already exists in the system or email is not populated with entityId and entityTypeCode
  - updateEmail
```
public EntityEmail updateEmail(EntityEmail email)
                        throws RiceIllegalArgumentException,
                               RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will update a EntityEmail exactly like the email passed in.
    
    Specified by:
    
    updateEmail in interface IdentityService
    
    Parameters:
    email - the EntityEmail to update
    
    Returns:
    the updated EntityEmail object.
    
    Throws:
    
    RiceIllegalArgumentException - if the email is null
    
    RiceIllegalStateException - if the email does not exist in the system.
  - inactivateEmail
```
public EntityEmail inactivateEmail(String emailId)
                            throws RiceIllegalArgumentException,
                                   RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will inactivate the EntityEmail with the passed in id.
    
    Specified by:
    
    inactivateEmail in interface IdentityService
    
    Parameters:
    emailId - the unique id of the EntityEmail to inactivate
    
    Returns:
    the inactivated EntityEmail object.
    
    Throws:
    
    RiceIllegalArgumentException - if the id is null
    
    RiceIllegalStateException - if the email does not exist in the system.
  - getEntityPhoneBo
```
protected EntityPhoneBo getEntityPhoneBo(String entityId,
                             String entityTypeCode,
                             String phoneTypeCode)
```
  - getEntityPhoneBo
```
protected EntityPhoneBo getEntityPhoneBo(String phoneId)
```
  - addPhoneToEntity
```
public EntityPhone addPhoneToEntity(EntityPhone phone)
                             throws RiceIllegalArgumentException,
                                    RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    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
    
    Specified by:
    
    addPhoneToEntity in interface IdentityService
    
    Parameters:
    phone - the EntityPhone to create
    
    Returns:
    the newly created EntityPhone object.
    
    Throws:
    
    RiceIllegalArgumentException - if the phone is null
    
    RiceIllegalStateException - if the phone already exists in the system or phone is not populated with entityId and entityTypeCode
  - updatePhone
```
public EntityPhone updatePhone(EntityPhone phone)
                        throws RiceIllegalArgumentException,
                               RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will update a EntityPhone exactly like the phone passed in.
    
    Specified by:
    
    updatePhone in interface IdentityService
    
    Parameters:
    phone - the EntityPhone to update
    
    Returns:
    the updated EntityPhone object.
    
    Throws:
    
    RiceIllegalArgumentException - if the phone is null
    
    RiceIllegalStateException - if the phone does not exist in the system.
  - inactivatePhone
```
public EntityPhone inactivatePhone(String phoneId)
                            throws RiceIllegalArgumentException,
                                   RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will inactivate the EntityPhone with the passed in id.
    
    Specified by:
    
    inactivatePhone in interface IdentityService
    
    Parameters:
    phoneId - the unique id of the EntityPhone to inactivate
    
    Returns:
    the inactivated EntityPhone object.
    
    Throws:
    
    RiceIllegalArgumentException - if the id is null
    
    RiceIllegalStateException - if the phone does not exist in the system.
  - getEntityExternalIdentifierBo
```
protected EntityExternalIdentifierBo getEntityExternalIdentifierBo(String entityId,
                                                       String externalIdentifierTypeCode)
```
  - addExternalIdentifierToEntity
```
public EntityExternalIdentifier addExternalIdentifierToEntity(EntityExternalIdentifier externalId)
                                                       throws RiceIllegalArgumentException,
                                                              RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    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
    
    Specified by:
    
    addExternalIdentifierToEntity in interface IdentityService
    
    Parameters:
    externalId - the EntityExternalIdentifier to create
    
    Returns:
    the newly created EntityExternalIdentifier object.
    
    Throws:
    
    RiceIllegalArgumentException - if the externalId is null
    
    RiceIllegalStateException - if the externalId already exists in the system or externalId is not populated with entityId and externalIdentifierTypeCode
  - updateExternalIdentifier
```
public EntityExternalIdentifier updateExternalIdentifier(EntityExternalIdentifier externalId)
                                                  throws RiceIllegalArgumentException,
                                                         RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will update a EntityExternalIdentifier exactly like the externalId passed in.
    
    Specified by:
    
    updateExternalIdentifier in interface IdentityService
    
    Parameters:
    externalId - the EntityExternalIdentifier to update
    
    Returns:
    the updated EntityExternalIdentifier object.
    
    Throws:
    
    RiceIllegalArgumentException - if the externalId is null
    
    RiceIllegalStateException - if the externalId does not exist in the system.
  - getEntityAffiliationBo
```
protected EntityAffiliationBo getEntityAffiliationBo(String id)
```
  - addAffiliationToEntity
```
public EntityAffiliation addAffiliationToEntity(EntityAffiliation affiliation)
                                         throws RiceIllegalArgumentException,
                                                RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    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
    
    Specified by:
    
    addAffiliationToEntity in interface IdentityService
    
    Parameters:
    affiliation - the EntityAffiliation to create
    
    Returns:
    the newly created EntityAffiliation object.
    
    Throws:
    
    RiceIllegalArgumentException - if the affiliation is null
    
    RiceIllegalStateException - if the affiliation already exists in the system or affiliation is not populated with entityId and affiliationType
  - updateAffiliation
```
public EntityAffiliation updateAffiliation(EntityAffiliation affiliation)
                                    throws RiceIllegalArgumentException,
                                           RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will update a EntityAffiliation exactly like the affiliation passed in.
    
    Specified by:
    
    updateAffiliation in interface IdentityService
    
    Parameters:
    affiliation - the EntityAffiliation to update
    
    Returns:
    the updated EntityAffiliation object.
    
    Throws:
    
    RiceIllegalArgumentException - if the affiliation is null
    
    RiceIllegalStateException - if the affiliation does not exist in the system.
  - inactivateAffiliation
```
public EntityAffiliation inactivateAffiliation(String id)
                                        throws RiceIllegalArgumentException,
                                               RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will inactivate a EntityAffiliation with the id passed in.
    
    Specified by:
    
    inactivateAffiliation in interface IdentityService
    
    Parameters:
    id - the unique id of the EntityAffiliation to inactivate
    
    Returns:
    the updated EntityAffiliation object.
    
    Throws:
    
    RiceIllegalArgumentException - if the affiliation is null
    
    RiceIllegalStateException - if the affiliation does not exist in the system.
  - findEntities
```
public EntityQueryResults findEntities(QueryByCriteria queryByCriteria)
                                throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    This method finds Entities based on a query criteria. The criteria cannot be null.
    
    Specified by:
    
    findEntities in interface IdentityService
    
    Parameters:
    queryByCriteria - the criteria. Cannot be null.
    
    Returns:
    query results. will never return null.
    
    Throws:
    
    RiceIllegalArgumentException - if the queryByCriteria is null
  - findEntityDefaults
```
public EntityDefaultQueryResults findEntityDefaults(QueryByCriteria queryByCriteria)
                                             throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    This method finds EntityDefault data based on a query criteria. The criteria cannot be null.
    
    Specified by:
    
    findEntityDefaults in interface IdentityService
    
    Parameters:
    queryByCriteria - the criteria. Cannot be null.
    
    Returns:
    query results. will never return null.
    
    Throws:
    
    RiceIllegalArgumentException - if the queryByCriteria is null
  - findNames
```
protected EntityNameQueryResults findNames(QueryByCriteria queryByCriteria)
```
  - getEntityPrivacyPreferences
```
public EntityPrivacyPreferences getEntityPrivacyPreferences(String entityId)
                                                     throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets a EntityPrivacyPreferences for a given id.
    This method will return null if the EntityPrivacyPreferences does not exist.
    
    Specified by:
    
    getEntityPrivacyPreferences in interface IdentityService
    
    Parameters:
    entityId - the unique id to retrieve the EntityPrivacyPreferences by. Cannot be null.
    
    Returns:
    a EntityPrivacyPreferences or null
    
    Throws:
    
    RiceIllegalArgumentException - if the entityId is blank
  - getPrincipal
```
public Principal getPrincipal(String principalId)
                       throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets a Principal from an principalId.
    This method will return null if the Principal does not exist.
    
    Specified by:
    
    getPrincipal in interface IdentityService
    
    Parameters:
    principalId - the unique id to retrieve the principal by. cannot be null.
    
    Returns:
    a Principal or null
    
    Throws:
    
    RiceIllegalArgumentException - if the principalId is blank
  - getPrincipals
```
public List<Principal> getPrincipals(List<String> principalIds)
```
    Description copied from interface: IdentityService
    
    Gets a list of Principal from a string list of principalId.
    This method will only return principals that exist.
    
    Specified by:
    
    getPrincipals in interface IdentityService
    
    Parameters:
    principalIds - the unique id to retrieve the principal by. cannot be null.
    
    Returns:
    a list of Principal
  - getPrincipalBo
```
protected PrincipalBo getPrincipalBo(String principalId)
```
  - getEntityBo
```
protected EntityBo getEntityBo(String entityId)
```
  - getPrincipalByPrincipalName
```
public Principal getPrincipalByPrincipalName(String principalName)
                                      throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets a Principal from an principalName.
    This method will return null if the Principal does not exist.
    
    Specified by:
    
    getPrincipalByPrincipalName in interface IdentityService
    
    Parameters:
    principalName - the unique id to retrieve the principal by. cannot be null.
    
    Returns:
    a Principal or null
    
    Throws:
    
    RiceIllegalArgumentException
  - getPrincipalBoByPrincipalName
```
protected PrincipalBo getPrincipalBoByPrincipalName(String principalName)
                                             throws RiceIllegalArgumentException
```
    Throws:
    
    RiceIllegalArgumentException
  - getPrincipalsByEntityId
```
public List<Principal> getPrincipalsByEntityId(String entityId)
                                        throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets a list of Principal from an entityId.
    This method will only return principals that exist.
    
    Specified by:
    
    getPrincipalsByEntityId in interface IdentityService
    
    Parameters:
    entityId - the unique id to retrieve the principals by. cannot be null.
    
    Returns:
    a list of Principal
    
    Throws:
    
    RiceIllegalArgumentException - if the entityId is blank
  - getPrincipalsByEmployeeId
```
public List<Principal> getPrincipalsByEmployeeId(String employeeId)
                                          throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets a list of Principal from an employeeId
    This method will only return principals that exist.
    
    Specified by:
    
    getPrincipalsByEmployeeId in interface IdentityService
    
    Parameters:
    employeeId - the employee id to retrieve the principals by. cannot be null.
    
    Returns:
    a list of Principal
    
    Throws:
    
    RiceIllegalArgumentException - if the employeeId is blank
  - getEntityBoByPrincipalName
```
protected EntityBo getEntityBoByPrincipalName(String principalName)
```
    See Also:
    IdentityService.getEntityByPrincipalName(java.lang.String)
  - getEntityBoByPrincipalId
```
protected EntityBo getEntityBoByPrincipalId(String principalId)
```
    See Also:
    IdentityService.getEntityByPrincipalId(java.lang.String)
  - getEntityBoByEmployeeId
```
protected EntityBo getEntityBoByEmployeeId(String employeeId)
```
    See Also:
    IdentityService.getEntityByEmployeeId(java.lang.String)
  - getEntityByKeyValue
```
protected EntityBo getEntityByKeyValue(String key,
                           String value)
```
    Generic helper method for performing a lookup through the business object service.
  - getAddressType
```
public CodedAttribute getAddressType(String code)
                              throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets the CodedAttribute for a given EntityAddressType code.
    This method will return null if the code does not exist.
    
    Specified by:
    
    getAddressType in interface IdentityService
    
    Parameters:
    code - the unique id to retrieve the Type by. Cannot be null.
    
    Returns:
    a CodedAttribute or null
    
    Throws:
    
    RiceIllegalArgumentException - if the code is blank
  - findAllAddressTypes
```
public List<CodedAttribute> findAllAddressTypes()
```
    Description copied from interface: IdentityService
    
    Finds all EntityAddressTypes
    
    Specified by:
    
    findAllAddressTypes in interface IdentityService
    
    Returns:
    a list of CodedAttribute
  - getAffiliationType
```
public EntityAffiliationType getAffiliationType(String code)
                                         throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets the EntityAffiliationType for a given EntityAffiliationType code.
    This method will return null if the code does not exist.
    
    Specified by:
    
    getAffiliationType in interface IdentityService
    
    Parameters:
    code - the unique id to retrieve the EntityAffiliationType by. Cannot be null.
    
    Returns:
    a EntityAffiliationType or null
    
    Throws:
    
    RiceIllegalArgumentException - if the code is blank
  - findAllAffiliationTypes
```
public List<EntityAffiliationType> findAllAffiliationTypes()
```
    Description copied from interface: IdentityService
    
    Finds all EntityAffiliationTypes
    
    Specified by:
    
    findAllAffiliationTypes in interface IdentityService
    
    Returns:
    a list of EntityAffiliationType
  - getCitizenshipStatus
```
public CodedAttribute getCitizenshipStatus(String code)
                                    throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets the CodedAttribute for a given EntityCitizenship status code.
    This method will return null if the code does not exist.
    
    Specified by:
    
    getCitizenshipStatus in interface IdentityService
    
    Parameters:
    code - the unique id to retrieve the Type by. Cannot be null.
    
    Returns:
    a CodedAttribute or null
    
    Throws:
    
    RiceIllegalArgumentException - if the code is blank
  - findAllCitizenshipStatuses
```
public List<CodedAttribute> findAllCitizenshipStatuses()
```
    Description copied from interface: IdentityService
    
    Finds all EntityCitizenshipStatuses
    
    Specified by:
    
    findAllCitizenshipStatuses in interface IdentityService
    
    Returns:
    a list of CodedAttribute
  - getEmailType
```
public CodedAttribute getEmailType(String code)
                            throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets the CodedAttribute for a given EntityEmail type code.
    This method will return null if the code does not exist.
    
    Specified by:
    
    getEmailType in interface IdentityService
    
    Parameters:
    code - the unique id to retrieve the Type by. Cannot be null.
    
    Returns:
    a CodedAttribute or null
    
    Throws:
    
    RiceIllegalArgumentException - if the code is blank
  - findAllEmailTypes
```
public List<CodedAttribute> findAllEmailTypes()
```
    Description copied from interface: IdentityService
    
    Finds all EntityEmailTypes
    
    Specified by:
    
    findAllEmailTypes in interface IdentityService
    
    Returns:
    a list of CodedAttribute
  - findPrincipals
```
public PrincipalQueryResults findPrincipals(QueryByCriteria query)
                                     throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    This method finds Principals based on a query criteria. The criteria cannot be null.
    
    Specified by:
    
    findPrincipals in interface IdentityService
    
    Parameters:
    query - the criteria. Cannot be null.
    
    Returns:
    query results. will never return null.
    
    Throws:
    
    RiceIllegalArgumentException
  - getEmploymentStatus
```
public CodedAttribute getEmploymentStatus(String code)
                                   throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets the CodedAttribute for a given EntityEmployment status code.
    This method will return null if the code does not exist.
    
    Specified by:
    
    getEmploymentStatus in interface IdentityService
    
    Parameters:
    code - the unique id to retrieve the Type by. Cannot be null.
    
    Returns:
    a CodedAttribute or null
    
    Throws:
    
    RiceIllegalArgumentException - if the code is blank
  - findAllEmploymentStatuses
```
public List<CodedAttribute> findAllEmploymentStatuses()
```
    Description copied from interface: IdentityService
    
    Finds all EntityEmploymentStatuses
    
    Specified by:
    
    findAllEmploymentStatuses in interface IdentityService
    
    Returns:
    a list of CodedAttribute
  - getEmploymentType
```
public CodedAttribute getEmploymentType(String code)
                                 throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets the CodedAttribute for a given EntityEmployment type code.
    This method will return null if the code does not exist.
    
    Specified by:
    
    getEmploymentType in interface IdentityService
    
    Parameters:
    code - the unique id to retrieve the Type by. Cannot be null.
    
    Returns:
    a CodedAttribute or null
    
    Throws:
    
    RiceIllegalArgumentException - if the code is blank
  - findAllEmploymentTypes
```
public List<CodedAttribute> findAllEmploymentTypes()
```
    Description copied from interface: IdentityService
    
    Finds all EntityEmploymentTypes
    
    Specified by:
    
    findAllEmploymentTypes in interface IdentityService
    
    Returns:
    a list of CodedAttribute
  - getNameType
```
public CodedAttribute getNameType(String code)
                           throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets the CodedAttribute for a given EntityName type code.
    This method will return null if the code does not exist.
    
    Specified by:
    
    getNameType in interface IdentityService
    
    Parameters:
    code - the unique id to retrieve the Type by. Cannot be null.
    
    Returns:
    a CodedAttribute or null
    
    Throws:
    
    RiceIllegalArgumentException - if the code is blank
  - findAllNameTypes
```
public List<CodedAttribute> findAllNameTypes()
```
    Description copied from interface: IdentityService
    
    Finds all EntityNameTypes
    
    Specified by:
    
    findAllNameTypes in interface IdentityService
    
    Returns:
    a list of CodedAttribute
  - getEntityType
```
public CodedAttribute getEntityType(String code)
                             throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets the CodedAttribute for a given EntityType code.
    This method will return null if the code does not exist.
    
    Specified by:
    
    getEntityType in interface IdentityService
    
    Parameters:
    code - the unique id to retrieve the Type by. Cannot be null.
    
    Returns:
    a CodedAttribute or null
    
    Throws:
    
    RiceIllegalArgumentException - if the code is blank
  - findAllEntityTypes
```
public List<CodedAttribute> findAllEntityTypes()
```
    Description copied from interface: IdentityService
    
    Finds all EntityTypes
    
    Specified by:
    
    findAllEntityTypes in interface IdentityService
    
    Returns:
    a list of CodedAttribute
  - getExternalIdentifierType
```
public EntityExternalIdentifierType getExternalIdentifierType(String code)
                                                       throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets the EntityExternalIdentifierType for a given type code.
    This method will return null if the code does not exist.
    
    Specified by:
    
    getExternalIdentifierType in interface IdentityService
    
    Parameters:
    code - the unique id to retrieve the EntityExternalIdentifierType by. Cannot be null.
    
    Returns:
    a CodedAttribute or null
    
    Throws:
    
    RiceIllegalArgumentException - if the code is blank
  - findAllExternalIdendtifierTypes
```
public List<EntityExternalIdentifierType> findAllExternalIdendtifierTypes()
```
    Description copied from interface: IdentityService
    
    Finds all ExternalIdentifierTypes
    
    Specified by:
    
    findAllExternalIdendtifierTypes in interface IdentityService
    
    Returns:
    a list of EntityExternalIdentifierType
  - getPhoneType
```
public CodedAttribute getPhoneType(String code)
                            throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    Gets the CodedAttribute for a given EntityPhone type code.
    This method will return null if the code does not exist.
    
    Specified by:
    
    getPhoneType in interface IdentityService
    
    Parameters:
    code - the unique id to retrieve the Type by. Cannot be null.
    
    Returns:
    a CodedAttribute or null
    
    Throws:
    
    RiceIllegalArgumentException - if the code is blank
  - findAllPhoneTypes
```
public List<CodedAttribute> findAllPhoneTypes()
```
    Description copied from interface: IdentityService
    
    Finds all EntityPhoneTypes
    
    Specified by:
    
    findAllPhoneTypes in interface IdentityService
    
    Returns:
    a list of CodedAttribute
  - createEntity
```
public Entity createEntity(Entity entity)
                    throws RiceIllegalArgumentException,
                           RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will create a Entity exactly like the entity passed in.
    
    Specified by:
    
    createEntity in interface IdentityService
    
    Parameters:
    entity - the entity to create
    
    Returns:
    the newly created Entity object.
    
    Throws:
    
    RiceIllegalArgumentException - if the entity is null
    
    RiceIllegalStateException - if the entity already exists in the system
  - updateEntity
```
public Entity updateEntity(Entity entity)
                    throws RiceIllegalArgumentException,
                           RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will update a Entity.
    
    Specified by:
    
    updateEntity in interface IdentityService
    
    Parameters:
    entity - the entity to update
    
    Returns:
    the updated Entity object.
    
    Throws:
    
    RiceIllegalArgumentException - if the entity is null
    
    RiceIllegalStateException - if the entity does not already exist in the system
  - inactivateEntity
```
public Entity inactivateEntity(String entityId)
                        throws RiceIllegalArgumentException,
                               RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will inactivate a Entity.
    
    Specified by:
    
    inactivateEntity in interface IdentityService
    
    Parameters:
    entityId - the unique id of the entity to inactivate
    
    Returns:
    the inactivated Entity object.
    
    Throws:
    
    RiceIllegalArgumentException - if the entity is null
    
    RiceIllegalStateException - if the entity does not already exist in the system
  - addPrivacyPreferencesToEntity
```
public EntityPrivacyPreferences addPrivacyPreferencesToEntity(EntityPrivacyPreferences privacyPreferences)
                                                       throws RiceIllegalArgumentException,
                                                              RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will create a EntityPrivacyPreferences exactly like the privacyPreferences passed in. The EntityPrivacyPreferences object passed in must be populated with an entityId
    
    Specified by:
    
    addPrivacyPreferencesToEntity in interface IdentityService
    
    Parameters:
    privacyPreferences - the EntityPrivacyPreferences to create
    
    Returns:
    the newly created EntityPrivacyPreferences object.
    
    Throws:
    
    RiceIllegalArgumentException - if the privacyPreferences is null
    
    RiceIllegalStateException - if the privacyPreferences already exists in the system or privacyPreferences is not populated with entityId
  - updatePrivacyPreferences
```
public EntityPrivacyPreferences updatePrivacyPreferences(EntityPrivacyPreferences privacyPreferences)
                                                  throws RiceIllegalArgumentException,
                                                         RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will update a EntityPrivacyPreferences exactly like the privacyPreferences passed in.
    
    Specified by:
    
    updatePrivacyPreferences in interface IdentityService
    
    Parameters:
    privacyPreferences - the EntityPrivacyPreferences to update
    
    Returns:
    the updated EntityPrivacyPreferences object.
    
    Throws:
    
    RiceIllegalArgumentException - if the privacyPreferences is null
    
    RiceIllegalStateException - if the privacyPreferences does not exist in the system.
  - getEntityCitizenshipBo
```
protected EntityCitizenshipBo getEntityCitizenshipBo(String entityId,
                                         String citizenshipStatusCode)
```
  - getEntityCitizenshipBo
```
protected EntityCitizenshipBo getEntityCitizenshipBo(String id)
```
  - addCitizenshipToEntity
```
public EntityCitizenship addCitizenshipToEntity(EntityCitizenship citizenship)
                                         throws RiceIllegalArgumentException,
                                                RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    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
    
    Specified by:
    
    addCitizenshipToEntity in interface IdentityService
    
    Parameters:
    citizenship - the EntityCitizenship to create
    
    Returns:
    the newly created EntityCitizenship object.
    
    Throws:
    
    RiceIllegalArgumentException - if the citizenship is null
    
    RiceIllegalStateException - if the citizenship already exists in the system or citizenship is not populated with entityId and status
  - updateCitizenship
```
public EntityCitizenship updateCitizenship(EntityCitizenship citizenship)
                                    throws RiceIllegalArgumentException,
                                           RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will update a EntityCitizenship exactly like the citizenship passed in.
    
    Specified by:
    
    updateCitizenship in interface IdentityService
    
    Parameters:
    citizenship - the EntityCitizenship to update
    
    Returns:
    the updated EntityCitizenship object.
    
    Throws:
    
    RiceIllegalArgumentException - if the citizenship is null
    
    RiceIllegalStateException - if the citizenship does not exist in the system.
  - inactivateCitizenship
```
public EntityCitizenship inactivateCitizenship(String id)
                                        throws RiceIllegalArgumentException,
                                               RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will inactivate a EntityCitizenship with the unique id passed in.
    
    Specified by:
    
    inactivateCitizenship in interface IdentityService
    
    Parameters:
    id - the id of the EntityCitizenship to inactivate
    
    Returns:
    the inactivated EntityCitizenship object.
    
    Throws:
    
    RiceIllegalArgumentException - if the citizenship is null
    
    RiceIllegalStateException - if the citizenship does not exist in the system.
  - getEntityEthnicityBo
```
protected EntityEthnicityBo getEntityEthnicityBo(String ethnicityId)
```
  - addEthnicityToEntity
```
public EntityEthnicity addEthnicityToEntity(EntityEthnicity ethnicity)
                                     throws RiceIllegalArgumentException
```
    Description copied from interface: IdentityService
    
    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
    
    Specified by:
    
    addEthnicityToEntity in interface IdentityService
    
    Parameters:
    ethnicity - the EntityEthnicity to create
    
    Returns:
    the newly created EntityEthnicity object.
    
    Throws:
    
    RiceIllegalArgumentException - if the ethnicity is null
  - updateEthnicity
```
public EntityEthnicity updateEthnicity(EntityEthnicity ethnicity)
                                throws RiceIllegalArgumentException,
                                       RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will update a EntityEthnicity exactly like the ethnicity passed in.
    
    Specified by:
    
    updateEthnicity in interface IdentityService
    
    Parameters:
    ethnicity - the EntityEthnicity to update
    
    Returns:
    the updated EntityEthnicity object.
    
    Throws:
    
    RiceIllegalArgumentException - if the ethnicity is null
    
    RiceIllegalStateException - if the ethnicity does not exist in the system.
  - getEntityResidencyBo
```
protected EntityResidencyBo getEntityResidencyBo(String residencyId)
```
  - addResidencyToEntity
```
public EntityResidency addResidencyToEntity(EntityResidency residency)
                                     throws RiceIllegalArgumentException,
                                            RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will create a EntityResidency exactly like the residency passed in. The EntityResidency object passed in must be populated with an entityId
    
    Specified by:
    
    addResidencyToEntity in interface IdentityService
    
    Parameters:
    residency - the EntityResidency to create
    
    Returns:
    the newly created EntityResidency object.
    
    Throws:
    
    RiceIllegalArgumentException - if the residency is null
    
    RiceIllegalStateException - if the residency already exists in the system or residency is not populated with entityId
  - updateResidency
```
public EntityResidency updateResidency(EntityResidency residency)
                                throws RiceIllegalArgumentException,
                                       RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will update a EntityResidency exactly like the residency passed in.
    
    Specified by:
    
    updateResidency in interface IdentityService
    
    Parameters:
    residency - the EntityResidency to update
    
    Returns:
    the updated EntityResidency object.
    
    Throws:
    
    RiceIllegalArgumentException - if the residency is null
    
    RiceIllegalStateException - if the residency does not exist in the system.
  - getEntityVisaBo
```
protected EntityVisaBo getEntityVisaBo(String visaId)
```
  - addVisaToEntity
```
public EntityVisa addVisaToEntity(EntityVisa visa)
                           throws RiceIllegalArgumentException,
                                  RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    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
    
    Specified by:
    
    addVisaToEntity in interface IdentityService
    
    Parameters:
    visa - the EntityVisa to create
    
    Returns:
    the newly created EntityVisa object.
    
    Throws:
    
    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
  - updateVisa
```
public EntityVisa updateVisa(EntityVisa visa)
                      throws RiceIllegalArgumentException,
                             RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will update a EntityVisa exactly like the visa passed in.
    
    Specified by:
    
    updateVisa in interface IdentityService
    
    Parameters:
    visa - the EntityVisa to update
    
    Returns:
    the updated EntityVisa object.
    
    Throws:
    
    RiceIllegalArgumentException - if the visa is null
    
    RiceIllegalStateException - if the visa does not exist in the system.
  - getEntityNameBo
```
protected EntityNameBo getEntityNameBo(String entityId,
                           String nameTypeCode)
```
  - getEntityNameBo
```
protected EntityNameBo getEntityNameBo(String id)
```
  - getDefaultNamesForPrincipalId
```
public EntityNamePrincipalName getDefaultNamesForPrincipalId(String principalId)
```
    Description copied from interface: IdentityService
    
    This returns the display name information for the given principal without loading the full person object.
    
    Specified by:
    
    getDefaultNamesForPrincipalId in interface IdentityService
    
    Parameters:
    principalId - The principal ID to find the name information for
    
    Returns:
    The default name information for the principal
  - getDefaultNamesForPrincipalIds
```
public Map<String,EntityNamePrincipalName> getDefaultNamesForPrincipalIds(List<String> principalIds)
```
    Description copied from interface: IdentityService
    
    This returns the display name information for the given principals without loading the full person object.
    
    Specified by:
    
    getDefaultNamesForPrincipalIds in interface IdentityService
    
    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
```
public 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.
    
    Specified by:
    
    getPrivacyPreferencesForPrincipalId in interface IdentityService
    
    Parameters:
    principalId - the principal id
    
    Returns:
    The privacy preferences for the given principal id, or null if the principal id is invalid.
  - addNameToEntity
```
public EntityName addNameToEntity(EntityName name)
                           throws RiceIllegalArgumentException,
                                  RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    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
    
    Specified by:
    
    addNameToEntity in interface IdentityService
    
    Parameters:
    name - the EntityName to create
    
    Returns:
    the newly created EntityName object.
    
    Throws:
    
    RiceIllegalArgumentException - if the name is null
    
    RiceIllegalStateException - if the name already exists in the system or name is not populated with entityId and nameType
  - updateName
```
public EntityName updateName(EntityName name)
                      throws RiceIllegalArgumentException,
                             RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will update a EntityName exactly like the name passed in.
    
    Specified by:
    
    updateName in interface IdentityService
    
    Parameters:
    name - the EntityName to update
    
    Returns:
    the updated EntityName object.
    
    Throws:
    
    RiceIllegalArgumentException - if the name is null
    
    RiceIllegalStateException - if the name does not exist in the system.
  - inactivateName
```
public EntityName inactivateName(String id)
                          throws RiceIllegalArgumentException,
                                 RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will inactivate a EntityName with the passed in id.
    
    Specified by:
    
    inactivateName in interface IdentityService
    
    Parameters:
    id - the unique id of the EntityName to inactivate
    
    Returns:
    the inactivated EntityName object.
    
    Throws:
    
    RiceIllegalArgumentException - if the id is null
    
    RiceIllegalStateException - if the name with the id does not exist in the system.
  - getEntityEmploymentBo
```
protected EntityEmploymentBo getEntityEmploymentBo(String entityId,
                                       String employmentTypeCode,
                                       String employmentStatusCode,
                                       String employmentAffiliationId)
```
  - getEntityEmploymentBo
```
protected EntityEmploymentBo getEntityEmploymentBo(String id)
```
  - addEmploymentToEntity
```
public EntityEmployment addEmploymentToEntity(EntityEmployment employment)
                                       throws RiceIllegalArgumentException,
                                              RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    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
    
    Specified by:
    
    addEmploymentToEntity in interface IdentityService
    
    Parameters:
    employment - the EntityEmployment to create
    
    Returns:
    the newly created EntityName object.
    
    Throws:
    
    RiceIllegalArgumentException - if the employment is null
    
    RiceIllegalStateException - if the employment already exists in the system or employment is not populated with entityId and employmentType
  - updateEmployment
```
public EntityEmployment updateEmployment(EntityEmployment employment)
                                  throws RiceIllegalArgumentException,
                                         RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will update a EntityEmployment exactly like the employment passed in.
    
    Specified by:
    
    updateEmployment in interface IdentityService
    
    Parameters:
    employment - the EntityEmployment to update
    
    Returns:
    the updated EntityEmployment object.
    
    Throws:
    
    RiceIllegalArgumentException - if the employment is null
    
    RiceIllegalStateException - if the employment does not exist in the system.
  - inactivateEmployment
```
public EntityEmployment inactivateEmployment(String id)
                                      throws RiceIllegalArgumentException,
                                             RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will inactivate a EntityEmployment with the passed in id.
    
    Specified by:
    
    inactivateEmployment in interface IdentityService
    
    Parameters:
    id - the unique id of the EntityEmployment to inactivate
    
    Returns:
    the inactivated EntityEmployment object.
    
    Throws:
    
    RiceIllegalArgumentException - if the id is null
    
    RiceIllegalStateException - if the employment with the id does not exist in the system.
  - getEntityBioDemographicsBo
```
protected EntityBioDemographicsBo getEntityBioDemographicsBo(String entityId)
```
  - addBioDemographicsToEntity
```
public EntityBioDemographics addBioDemographicsToEntity(EntityBioDemographics bioDemographics)
                                                 throws RiceIllegalArgumentException,
                                                        RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will create a EntityBioDemographics exactly like the bioDemographics passed in. The EntityBioDemographics object passed in must be populated with an entityId
    
    Specified by:
    
    addBioDemographicsToEntity in interface IdentityService
    
    Parameters:
    bioDemographics - the EntityBioDemographics to create
    
    Returns:
    the newly created EntityBioDemographics object.
    
    Throws:
    
    RiceIllegalArgumentException - if the bioDemographics is null
    
    RiceIllegalStateException - if the bioDemographics already exists in the system or bioDemographics is not populated with entityId
  - updateBioDemographics
```
public EntityBioDemographics updateBioDemographics(EntityBioDemographics bioDemographics)
                                            throws RiceIllegalArgumentException,
                                                   RiceIllegalStateException
```
    Description copied from interface: IdentityService
    
    This will update a EntityBioDemographics exactly like the bioDemographics passed in.
    
    Specified by:
    
    updateBioDemographics in interface IdentityService
    
    Parameters:
    bioDemographics - the EntityBioDemographics to update
    
    Returns:
    the updated EntityBioDemographics object.
    
    Throws:
    
    RiceIllegalArgumentException - if the bioDemographics is null
    
    RiceIllegalStateException - if the bioDemographics does not exist in the system.
  - incomingParamCheck
```
protected void incomingParamCheck(Object object,
                      String name)
```
  - setDataObjectService
```
public void setDataObjectService(DataObjectService dataObjectService)
```
  - getIdentityServiceDao
```
public IdentityServiceDao getIdentityServiceDao()
```
  - setIdentityServiceDao
```
public void setIdentityServiceDao(IdentityServiceDao identityServiceDao)
```

Class IdentityServiceImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNAVAILABLE

dataObjectService

identityServiceDao

Constructor Detail

IdentityServiceImpl

Method Detail

getEntity

getEntityByPrincipalId

getEntityByPrincipalName

getEntityByEmployeeId

getEntityDefault

getEntityDefaultByPrincipalId

getEntityDefaultByPrincipalName

getEntityDefaultByEmployeeId

getPrincipalByPrincipalNameAndPassword

addPrincipalToEntity

updatePrincipal

inactivatePrincipal

inactivatePrincipalByName

addEntityTypeContactInfoToEntity

getEntityTypeDataBo

updateEntityTypeContactInfo

inactivateEntityTypeContactInfo

getEntityAddressBo

getEntityAddressBo

addAddressToEntity

updateAddress

inactivateAddress

getEntityEmailBo

getEntityEmailBo

addEmailToEntity

updateEmail

inactivateEmail

getEntityPhoneBo

getEntityPhoneBo

addPhoneToEntity

updatePhone

inactivatePhone

getEntityExternalIdentifierBo

addExternalIdentifierToEntity

updateExternalIdentifier

getEntityAffiliationBo

addAffiliationToEntity

updateAffiliation

inactivateAffiliation

findEntities

findEntityDefaults

findNames

getEntityPrivacyPreferences

getPrincipal

getPrincipals

getPrincipalBo

getEntityBo

getPrincipalByPrincipalName

getPrincipalBoByPrincipalName

getPrincipalsByEntityId

getPrincipalsByEmployeeId

getEntityBoByPrincipalName

getEntityBoByPrincipalId

getEntityBoByEmployeeId

getEntityByKeyValue

getAddressType

findAllAddressTypes

getAffiliationType

findAllAffiliationTypes

getCitizenshipStatus

findAllCitizenshipStatuses

getEmailType

findAllEmailTypes

findPrincipals

getEmploymentStatus

findAllEmploymentStatuses

getEmploymentType

findAllEmploymentTypes