IdentityCurrentAndArchivedServiceImpl (Rice 2.3.12 API)

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

All Implemented Interfaces:

IdentityService
```
public class IdentityCurrentAndArchivedServiceImpl
extends Object
implements IdentityService
```
This IdentityService implementation is largely just a knee-jerk delegator, except for getters returning EntityDefault in which case the IdentityArchiveService will be invoked if the inner IndentityService impl returns null.

Author:

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

Constructor Summary

Constructors
Constructor and Description
`IdentityCurrentAndArchivedServiceImpl(IdentityService innerIdentityService, IdentityArchiveService identityArchiveService)` This constructs a IdentityCurrentAndArchivedServiceImpl, injecting the needed services.

Method Summary

All Methods Instance Methods Concrete 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 entityTypeContactInfo)` 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.
`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.
`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.
`Entity`	`getEntityByEmployeeId(String employeeId)` Gets a `Entity` from a employeeId.
`Entity`	`getEntityByPrincipalId(String principalId)` Gets a `Entity` from a principalId.
`Entity`	`getEntityByPrincipalName(String principalName)` Gets a `Entity` from a principalName.
`EntityDefault`	`getEntityDefault(String entityId)` This method first tries the inner IdentityService impl, and resorts to the IdentityArchiveService if need be.
`EntityDefault`	`getEntityDefaultByEmployeeId(String employeeId)` This method first tries the inner IdentityService impl, and resorts to the IdentityArchiveService if need be.
`EntityDefault`	`getEntityDefaultByPrincipalId(String principalId)` This method first tries the inner IdentityService impl, and resorts to the IdentityArchiveService if need be.
`EntityDefault`	`getEntityDefaultByPrincipalName(String principalName)` This method first tries the inner IdentityService impl, and resorts to the IdentityArchiveService if need be.
`EntityPrivacyPreferences`	`getEntityPrivacyPreferences(String entityId)` Gets a `EntityPrivacyPreferences` for a given id.
`CodedAttribute`	`getEntityType(String code)` Gets the `CodedAttribute` for a given EntityType code.
`EntityExternalIdentifierType`	`getExternalIdentifierType(String code)` Gets the `EntityExternalIdentifierType` for a given type code.
`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.
`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.
`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`.
`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

- Constructor Detail
  - IdentityCurrentAndArchivedServiceImpl
```
public IdentityCurrentAndArchivedServiceImpl(IdentityService innerIdentityService,
                                             IdentityArchiveService identityArchiveService)
```
    This constructs a IdentityCurrentAndArchivedServiceImpl, injecting the needed services.
- Method Detail
  - getAddressType
```
public CodedAttribute getAddressType(String code)
```
    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
    
    See Also:
    
    IdentityService.getAddressType(java.lang.String)
  - 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)
```
    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
  - 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)
```
    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
    
    See Also:
    
    IdentityService.getCitizenshipStatus(java.lang.String)
  - findAllCitizenshipStatuses
```
public List<CodedAttribute> findAllCitizenshipStatuses()
```
    Description copied from interface: IdentityService
    
    Finds all EntityCitizenshipStatuses
    
    Specified by:
    
    findAllCitizenshipStatuses in interface IdentityService
    
    Returns:
    
    a list of CodedAttribute
  - 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
  - addNameToEntity
```
public EntityName addNameToEntity(EntityName name)
```
    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.
  - updateName
```
public EntityName updateName(EntityName name)
```
    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.
  - inactivateName
```
public EntityName inactivateName(String id)
```
    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.
  - addEmploymentToEntity
```
public EntityEmployment addEmploymentToEntity(EntityEmployment employment)
```
    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.
  - updateEmployment
```
public EntityEmployment updateEmployment(EntityEmployment employment)
```
    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.
  - inactivateEmployment
```
public EntityEmployment inactivateEmployment(String id)
```
    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.
  - addBioDemographicsToEntity
```
public EntityBioDemographics addBioDemographicsToEntity(EntityBioDemographics bioDemographics)
```
    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.
  - updateBioDemographics
```
public EntityBioDemographics updateBioDemographics(EntityBioDemographics bioDemographics)
```
    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.
  - getEmailType
```
public CodedAttribute getEmailType(String code)
```
    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
    
    See Also:
    
    IdentityService.getEmailType(java.lang.String)
  - 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)
```
    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
    
    See Also:
    
    IdentityService.getEmploymentStatus(java.lang.String)
  - 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)
```
    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
    
    See Also:
    
    IdentityService.getEmploymentType(java.lang.String)
  - findAllEmploymentTypes
```
public List<CodedAttribute> findAllEmploymentTypes()
```
    Description copied from interface: IdentityService
    
    Finds all EntityEmploymentTypes
    
    Specified by:
    
    findAllEmploymentTypes in interface IdentityService
    
    Returns:
    
    a list of CodedAttribute
  - getEntityDefault
```
public EntityDefault getEntityDefault(String entityId)
```
    This method first tries the inner IdentityService impl, and resorts to the IdentityArchiveService if need be.
    
    Specified by:
    
    getEntityDefault in interface IdentityService
    
    Parameters:
    
    entityId - the unique id to retrieve the entity by. cannot be null.
    
    Returns:
    
    a EntityDefault or null
  - getEntityDefaultByPrincipalId
```
public EntityDefault getEntityDefaultByPrincipalId(String principalId)
```
    This method first tries the inner IdentityService impl, and resorts to the IdentityArchiveService if need be.
    
    Specified by:
    
    getEntityDefaultByPrincipalId in interface IdentityService
    
    Parameters:
    
    principalId - the unique id to retrieve the entity by. cannot be null.
    
    Returns:
    
    a EntityDefault or null
  - getEntityDefaultByPrincipalName
```
public EntityDefault getEntityDefaultByPrincipalName(String principalName)
```
    This method first tries the inner IdentityService impl, and resorts to the IdentityArchiveService if need be.
    
    Specified by:
    
    getEntityDefaultByPrincipalName in interface IdentityService
    
    Parameters:
    
    principalName - the unique id to retrieve the entity by. cannot be null.
    
    Returns:
    
    a EntityDefault or null
  - getEntityDefaultByEmployeeId
```
public EntityDefault getEntityDefaultByEmployeeId(String employeeId)
```
    This method first tries the inner IdentityService impl, and resorts to the IdentityArchiveService if need be.
    
    Specified by:
    
    getEntityDefaultByEmployeeId in interface IdentityService
    
    Parameters:
    
    employeeId - the unique id to retrieve the entity by. cannot be null.
    
    Returns:
    
    a EntityDefault or null
  - findEntityDefaults
```
public EntityDefaultQueryResults findEntityDefaults(QueryByCriteria queryByCriteria)
```
    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.
  - findEntities
```
public EntityQueryResults findEntities(QueryByCriteria queryByCriteria)
```
    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.
  - getEntity
```
public Entity getEntity(String entityId)
```
    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
  - getEntityByPrincipalId
```
public Entity getEntityByPrincipalId(String principalId)
```
    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
  - getEntityByPrincipalName
```
public Entity getEntityByPrincipalName(String principalName)
```
    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
  - getEntityByEmployeeId
```
public Entity getEntityByEmployeeId(String employeeId)
```
    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
  - createEntity
```
public Entity createEntity(Entity entity)
```
    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.
  - updateEntity
```
public Entity updateEntity(Entity entity)
```
    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.
  - inactivateEntity
```
public Entity inactivateEntity(String entityId)
```
    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.
  - getNameType
```
public CodedAttribute getNameType(String code)
```
    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
    
    See Also:
    
    IdentityService.getNameType(java.lang.String)
  - findAllNameTypes
```
public List<CodedAttribute> findAllNameTypes()
```
    Description copied from interface: IdentityService
    
    Finds all EntityNameTypes
    
    Specified by:
    
    findAllNameTypes in interface IdentityService
    
    Returns:
    
    a list of CodedAttribute
  - getEntityPrivacyPreferences
```
public EntityPrivacyPreferences getEntityPrivacyPreferences(String entityId)
```
    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
  - addPrivacyPreferencesToEntity
```
public EntityPrivacyPreferences addPrivacyPreferencesToEntity(EntityPrivacyPreferences privacyPreferences)
```
    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.
  - updatePrivacyPreferences
```
public EntityPrivacyPreferences updatePrivacyPreferences(EntityPrivacyPreferences privacyPreferences)
```
    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.
  - addCitizenshipToEntity
```
public EntityCitizenship addCitizenshipToEntity(EntityCitizenship citizenship)
```
    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.
  - updateCitizenship
```
public EntityCitizenship updateCitizenship(EntityCitizenship citizenship)
```
    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.
  - inactivateCitizenship
```
public EntityCitizenship inactivateCitizenship(String id)
```
    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.
  - addEthnicityToEntity
```
public EntityEthnicity addEthnicityToEntity(EntityEthnicity ethnicity)
```
    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.
  - updateEthnicity
```
public EntityEthnicity updateEthnicity(EntityEthnicity ethnicity)
```
    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.
  - addResidencyToEntity
```
public EntityResidency addResidencyToEntity(EntityResidency residency)
```
    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.
  - updateResidency
```
public EntityResidency updateResidency(EntityResidency residency)
```
    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.
  - addVisaToEntity
```
public EntityVisa addVisaToEntity(EntityVisa visa)
```
    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.
  - updateVisa
```
public EntityVisa updateVisa(EntityVisa visa)
```
    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.
  - getEntityType
```
public CodedAttribute getEntityType(String code)
```
    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
    
    See Also:
    
    IdentityService.getEntityType(java.lang.String)
  - 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)
```
    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
  - 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)
```
    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
    
    See Also:
    
    IdentityService.getPhoneType(java.lang.String)
  - findAllPhoneTypes
```
public List<CodedAttribute> findAllPhoneTypes()
```
    Description copied from interface: IdentityService
    
    Finds all EntityPhoneTypes
    
    Specified by:
    
    findAllPhoneTypes in interface IdentityService
    
    Returns:
    
    a list of CodedAttribute
  - getPrincipal
```
public Principal getPrincipal(String principalId)
```
    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
  - getPrincipals
```
public 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. It will return null if the none of the principals 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 or null
    
    Throws:
    
    RiceIllegalArgumentException - if the principalId is blank
  - getPrincipalByPrincipalName
```
public Principal getPrincipalByPrincipalName(String principalName)
```
    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
  - getPrincipalsByEntityId
```
public List<Principal> getPrincipalsByEntityId(String entityId)
```
    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
  - getPrincipalsByEmployeeId
```
public List<Principal> getPrincipalsByEmployeeId(String employeeId)
```
    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
  - getPrincipalByPrincipalNameAndPassword
```
public Principal getPrincipalByPrincipalNameAndPassword(String principalName,
                                                        String password)
```
    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
  - addPrincipalToEntity
```
public Principal addPrincipalToEntity(Principal principal)
```
    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.
  - updatePrincipal
```
public Principal updatePrincipal(Principal principal)
```
    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.
  - inactivatePrincipal
```
public Principal inactivatePrincipal(String principalId)
```
    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.
  - inactivatePrincipalByName
```
public Principal inactivatePrincipalByName(String principalName)
```
    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.
  - addEntityTypeContactInfoToEntity
```
public EntityTypeContactInfo addEntityTypeContactInfoToEntity(EntityTypeContactInfo entityTypeContactInfo)
```
    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:
    
    entityTypeContactInfo - the EntityTypeContactInfo to create
    
    Returns:
    
    the newly created EntityTypeContactInfo object.
  - updateEntityTypeContactInfo
```
public EntityTypeContactInfo updateEntityTypeContactInfo(EntityTypeContactInfo entityTypeContactInfo)
```
    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.
  - inactivateEntityTypeContactInfo
```
public EntityTypeContactInfo inactivateEntityTypeContactInfo(String entityId,
                                                             String entityTypeCode)
```
    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.
  - addAddressToEntity
```
public EntityAddress addAddressToEntity(EntityAddress address)
```
    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.
  - updateAddress
```
public EntityAddress updateAddress(EntityAddress address)
```
    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.
  - inactivateAddress
```
public EntityAddress inactivateAddress(String addressId)
```
    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.
  - addEmailToEntity
```
public EntityEmail addEmailToEntity(EntityEmail email)
```
    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.
  - updateEmail
```
public EntityEmail updateEmail(EntityEmail email)
```
    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.
  - inactivateEmail
```
public EntityEmail inactivateEmail(String emailId)
```
    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.
  - addPhoneToEntity
```
public EntityPhone addPhoneToEntity(EntityPhone phone)
```
    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.
  - updatePhone
```
public EntityPhone updatePhone(EntityPhone phone)
```
    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.
  - inactivatePhone
```
public EntityPhone inactivatePhone(String phoneId)
```
    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.
  - addExternalIdentifierToEntity
```
public EntityExternalIdentifier addExternalIdentifierToEntity(EntityExternalIdentifier externalId)
```
    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.
  - updateExternalIdentifier
```
public EntityExternalIdentifier updateExternalIdentifier(EntityExternalIdentifier externalId)
```
    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.
  - addAffiliationToEntity
```
public EntityAffiliation addAffiliationToEntity(EntityAffiliation affiliation)
```
    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.
  - updateAffiliation
```
public EntityAffiliation updateAffiliation(EntityAffiliation affiliation)
```
    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.
  - inactivateAffiliation
```
public EntityAffiliation inactivateAffiliation(String id)
```
    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.

Class IdentityCurrentAndArchivedServiceImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IdentityCurrentAndArchivedServiceImpl

Method Detail

getAddressType

findAllAddressTypes

getAffiliationType

findAllAffiliationTypes

getCitizenshipStatus

findAllCitizenshipStatuses

getDefaultNamesForPrincipalId

addNameToEntity

updateName

inactivateName

addEmploymentToEntity

updateEmployment

inactivateEmployment

addBioDemographicsToEntity

updateBioDemographics

getEmailType

findAllEmailTypes

findPrincipals

getEmploymentStatus

findAllEmploymentStatuses

getEmploymentType

findAllEmploymentTypes

getEntityDefault

getEntityDefaultByPrincipalId

getEntityDefaultByPrincipalName

getEntityDefaultByEmployeeId

findEntityDefaults

findEntities

getEntity

getEntityByPrincipalId

getEntityByPrincipalName

getEntityByEmployeeId

createEntity

updateEntity

inactivateEntity

getNameType

findAllNameTypes

getEntityPrivacyPreferences

addPrivacyPreferencesToEntity

updatePrivacyPreferences

addCitizenshipToEntity

updateCitizenship

inactivateCitizenship

addEthnicityToEntity

updateEthnicity

addResidencyToEntity

updateResidency

addVisaToEntity

updateVisa

getEntityType

findAllEntityTypes

getExternalIdentifierType

findAllExternalIdendtifierTypes

getPhoneType

findAllPhoneTypes

getPrincipal

getPrincipals

getPrincipalByPrincipalName

getPrincipalsByEntityId

getPrincipalsByEmployeeId

getPrincipalByPrincipalNameAndPassword

addPrincipalToEntity

updatePrincipal

inactivatePrincipal

inactivatePrincipalByName

addEntityTypeContactInfoToEntity

updateEntityTypeContactInfo

inactivateEntityTypeContactInfo

addAddressToEntity

updateAddress

inactivateAddress

addEmailToEntity

updateEmail