org.kuali.rice.kim.service.impl
Class IdentityCurrentAndArchivedServiceImpl

java.lang.Object
  org.kuali.rice.kim.service.impl.IdentityCurrentAndArchivedServiceImpl

All Implemented Interfaces:

IdentityService, IdentityUpdateService

public class IdentityCurrentAndArchivedServiceImpl
extends Object
implements IdentityService, IdentityUpdateService

This IdentityService implementation is largely just a knee-jerk delegator, except for getters returning KimEntityDefaultInfo 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

IdentityCurrentAndArchivedServiceImpl(IdentityService innerIdentityService, IdentityArchiveService identityArchiveService)
This constructs a IdentityCurrentAndArchivedServiceImpl, injecting the needed services.

Method Summary

AddressTypeInfo	getAddressType(String code) Gets the address type for the given address type code.
AffiliationTypeInfo	getAffiliationType(String code) Gets the affiliation type for the given affiliation type code.
CitizenshipStatusInfo	getCitizenshipStatus(String code) Gets the citizenship status for the given citizenship status code.
Map<String,KimEntityNameInfo>	getDefaultNamesForEntityIds(List<String> entityIds) Gets the names for the entities with ids in the given list.
Map<String,KimEntityNamePrincipalNameInfo>	getDefaultNamesForPrincipalIds(List<String> principalIds) Gets the name for the principals with ids in the given List.
EmailTypeInfo	getEmailType(String code) Gets the email type for the given email type code.
EmploymentStatusInfo	getEmploymentStatus(String code) Gets the employment status for the given employment status code.
EmploymentTypeInfo	getEmploymentType(String code) Gets the employment type for the given employment type code.
KimEntityDefaultInfo	getEntityDefaultInfo(String entityId) This method first tries the inner IdentityService impl, and resorts to the IdentityArchiveService if need be.
KimEntityDefaultInfo	getEntityDefaultInfoByPrincipalId(String principalId) This method first tries the inner IdentityService impl, and resorts to the IdentityArchiveService if need be.
KimEntityDefaultInfo	getEntityDefaultInfoByPrincipalName(String principalName) This method first tries the inner IdentityService impl, and resorts to the IdentityArchiveService if need be.
KimEntityInfo	getEntityInfo(String entityId) Get the entity info for the entity with the given id.
KimEntityInfo	getEntityInfoByPrincipalId(String principalId) Get the entity info for the entity of the principal with the given principal id.
KimEntityInfo	getEntityInfoByPrincipalName(String principalName) Get the entity info for the entity of the principal with the given principal name.
EntityNameTypeInfo	getEntityNameType(String code) Gets the entity name type for the given entity name type code.
KimEntityPrivacyPreferencesInfo	getEntityPrivacyPreferences(String entityId) Gets the privacy preferences for the entity with the given entity id.
EntityTypeInfo	getEntityType(String code) Gets the entity type for the given entity type code.
ExternalIdentifierTypeInfo	getExternalIdentifierType(String code) Gets the external identifier type for the given external identifier type code.
int	getMatchingEntityCount(Map<String,String> searchCriteria) Returns a count of the number of entities that match the given search criteria.
PhoneTypeInfo	getPhoneType(String code) Gets the phone type for the given phone type code.
KimPrincipalInfo	getPrincipal(String principalId) Get the principal with the given unique principal ID.
KimPrincipalInfo	getPrincipalByPrincipalName(String principalName) Get the principal with the given principalName.
KimPrincipalInfo	getPrincipalByPrincipalNameAndPassword(String principalName, String password) Get the principal with the given name and password.
List<KimEntityDefaultInfo>	lookupEntityDefaultInfo(Map<String,String> searchCriteria, boolean unbounded) Gets a List of entity default info for entities based on the given search criteria.
List<KimEntityInfo>	lookupEntityInfo(Map<String,String> searchCriteria, boolean unbounded)

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 AddressTypeInfo getAddressType(String code)

Description copied from interface: IdentityService

Gets the address type for the given address type code.

Specified by:

getAddressType in interface IdentityService

See Also:

IdentityService.getAddressType(java.lang.String)

getAffiliationType

public AffiliationTypeInfo getAffiliationType(String code)

Description copied from interface: IdentityService

Gets the affiliation type for the given affiliation type code.

Specified by:

getAffiliationType in interface IdentityService

See Also:

IdentityService.getAffiliationType(java.lang.String)

getCitizenshipStatus

public CitizenshipStatusInfo getCitizenshipStatus(String code)

Description copied from interface: IdentityService

Gets the citizenship status for the given citizenship status code.

Specified by:

getCitizenshipStatus in interface IdentityService

See Also:

IdentityService.getCitizenshipStatus(java.lang.String)

getDefaultNamesForEntityIds

public Map<String,KimEntityNameInfo> getDefaultNamesForEntityIds(List<String> entityIds)

Description copied from interface: IdentityService

Gets the names for the entities with ids in the given list.

Specified by:

getDefaultNamesForEntityIds in interface IdentityService

See Also:

IdentityService.getDefaultNamesForEntityIds(java.util.List)

getDefaultNamesForPrincipalIds

public Map<String,KimEntityNamePrincipalNameInfo> getDefaultNamesForPrincipalIds(List<String> principalIds)

Description copied from interface: IdentityService

Gets the name for the principals with ids in the given List.

The resulting Map contains the principalId as the key and the name information as the value. When fetching names by principal id, the resulting name info contains the entity's name info as well as the principal's name info.

Specified by:

getDefaultNamesForPrincipalIds in interface IdentityService

See Also:

IdentityService.getDefaultNamesForPrincipalIds(java.util.List)

getEmailType

public EmailTypeInfo getEmailType(String code)

Description copied from interface: IdentityService

Gets the email type for the given email type code.

Specified by:

getEmailType in interface IdentityService

See Also:

IdentityService.getEmailType(java.lang.String)

getEmploymentStatus

public EmploymentStatusInfo getEmploymentStatus(String code)

Description copied from interface: IdentityService

Gets the employment status for the given employment status code.

Specified by:

getEmploymentStatus in interface IdentityService

See Also:

IdentityService.getEmploymentStatus(java.lang.String)

getEmploymentType

public EmploymentTypeInfo getEmploymentType(String code)

Description copied from interface: IdentityService

Gets the employment type for the given employment type code.

Specified by:

getEmploymentType in interface IdentityService

See Also:

IdentityService.getEmploymentType(java.lang.String)

getEntityDefaultInfo

public KimEntityDefaultInfo getEntityDefaultInfo(String entityId)

This method first tries the inner IdentityService impl, and resorts to the IdentityArchiveService if need be.

Specified by:

getEntityDefaultInfo in interface IdentityService

See Also:

IdentityService.getEntityDefaultInfo(java.lang.String)

getEntityDefaultInfoByPrincipalId

public KimEntityDefaultInfo getEntityDefaultInfoByPrincipalId(String principalId)

This method first tries the inner IdentityService impl, and resorts to the IdentityArchiveService if need be.

Specified by:

getEntityDefaultInfoByPrincipalId in interface IdentityService

See Also:

IdentityService.getEntityDefaultInfoByPrincipalId(java.lang.String)

getEntityDefaultInfoByPrincipalName

public KimEntityDefaultInfo getEntityDefaultInfoByPrincipalName(String principalName)

This method first tries the inner IdentityService impl, and resorts to the IdentityArchiveService if need be.

Specified by:

getEntityDefaultInfoByPrincipalName in interface IdentityService

See Also:

IdentityService.getEntityDefaultInfoByPrincipalName(java.lang.String)

getEntityInfo

public KimEntityInfo getEntityInfo(String entityId)

Description copied from interface: IdentityService

Get the entity info for the entity with the given id.

Specified by:

getEntityInfo in interface IdentityService

See Also:

IdentityService.getEntityInfo(java.lang.String)

getEntityInfoByPrincipalId

public KimEntityInfo getEntityInfoByPrincipalId(String principalId)

Description copied from interface: IdentityService

Get the entity info for the entity of the principal with the given principal id.

Specified by:

getEntityInfoByPrincipalId in interface IdentityService

See Also:

IdentityService.getEntityInfoByPrincipalId(java.lang.String)

getEntityInfoByPrincipalName

public KimEntityInfo getEntityInfoByPrincipalName(String principalName)

Description copied from interface: IdentityService

Get the entity info for the entity of the principal with the given principal name.

Specified by:

getEntityInfoByPrincipalName in interface IdentityService

See Also:

IdentityService.getEntityInfoByPrincipalName(java.lang.String)

getEntityNameType

public EntityNameTypeInfo getEntityNameType(String code)

Description copied from interface: IdentityService

Gets the entity name type for the given entity name type code.

Specified by:

getEntityNameType in interface IdentityService

See Also:

IdentityService.getEntityNameType(java.lang.String)

getEntityPrivacyPreferences

public KimEntityPrivacyPreferencesInfo getEntityPrivacyPreferences(String entityId)

Description copied from interface: IdentityService

Gets the privacy preferences for the entity with the given entity id.

Specified by:

getEntityPrivacyPreferences in interface IdentityService

See Also:

IdentityService.getEntityPrivacyPreferences(java.lang.String)

getEntityType

public EntityTypeInfo getEntityType(String code)

Description copied from interface: IdentityService

Gets the entity type for the given entity type code.

Specified by:

getEntityType in interface IdentityService

See Also:

IdentityService.getEntityType(java.lang.String)

getExternalIdentifierType

public ExternalIdentifierTypeInfo getExternalIdentifierType(String code)

Description copied from interface: IdentityService

Gets the external identifier type for the given external identifier type code.

Specified by:

getExternalIdentifierType in interface IdentityService

See Also:

IdentityService.getExternalIdentifierType(java.lang.String)

getMatchingEntityCount

public int getMatchingEntityCount(Map<String,String> searchCriteria)

Description copied from interface: IdentityService

Returns a count of the number of entities that match the given search criteria.

Specified by:

getMatchingEntityCount in interface IdentityService

See Also:

IdentityService.getMatchingEntityCount(java.util.Map)

getPhoneType

public PhoneTypeInfo getPhoneType(String code)

Description copied from interface: IdentityService

Gets the phone type for the given phone type code.

Specified by:

getPhoneType in interface IdentityService

See Also:

IdentityService.getPhoneType(java.lang.String)

getPrincipal

public KimPrincipalInfo getPrincipal(String principalId)

Description copied from interface: IdentityService

Get the principal with the given unique principal ID. Returns null if not found.

Specified by:

getPrincipal in interface IdentityService

See Also:

IdentityService.getPrincipal(java.lang.String)

getPrincipalByPrincipalName

public KimPrincipalInfo getPrincipalByPrincipalName(String principalName)

Description copied from interface: IdentityService

Get the principal with the given principalName.

Specified by:

getPrincipalByPrincipalName in interface IdentityService

See Also:

IdentityService.getPrincipalByPrincipalName(java.lang.String)

getPrincipalByPrincipalNameAndPassword

public KimPrincipalInfo getPrincipalByPrincipalNameAndPassword(String principalName,
                                                               String password)

Description copied from interface: IdentityService

Get the principal with the given name and password.

Specified by:

getPrincipalByPrincipalNameAndPassword in interface IdentityService

See Also:

IdentityService.getPrincipalByPrincipalNameAndPassword(java.lang.String, java.lang.String)

lookupEntityDefaultInfo

public List<KimEntityDefaultInfo> lookupEntityDefaultInfo(Map<String,String> searchCriteria,
                                                          boolean unbounded)

Description copied from interface: IdentityService

Gets a List of entity default info for entities based on the given search criteria.

If unbounded is set to false, then this method will return all results. If unbounded is set to true then the number of search results will be bounded based on default configuration for number of search results returned in a a bounded search.

The searchCriteria Map is a map of entity field names to search values.

Specified by:

lookupEntityDefaultInfo in interface IdentityService

See Also:

IdentityService.lookupEntityDefaultInfo(java.util.Map, boolean)

lookupEntityInfo

public List<KimEntityInfo> lookupEntityInfo(Map<String,String> searchCriteria,
                                            boolean unbounded)

Specified by:

lookupEntityInfo in interface IdentityService

See Also:

IdentityService.lookupEntityInfo(java.util.Map, boolean)