/*

  * Copyright 2008-2009 The Kuali Foundation

  * 

  * Licensed under the Educational Community License, Version 2.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  * 

  * http://www.opensource.org/licenses/ecl2.php

  * 

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package org.kuali.rice.kim.service.impl;

 import org.apache.commons.collections.CollectionUtils;

 import org.apache.commons.lang.StringUtils;

 import org.kuali.rice.core.api.criteria.CriteriaLookupService;

 import org.kuali.rice.core.api.criteria.GenericQueryResults;

 import org.kuali.rice.core.api.criteria.QueryByCriteria;

 import org.kuali.rice.core.api.exception.RiceIllegalArgumentException;

 import org.kuali.rice.core.api.exception.RiceIllegalStateException;

 import org.kuali.rice.kim.api.identity.Type;

 import org.kuali.rice.kim.api.identity.address.EntityAddress;

 import org.kuali.rice.kim.api.identity.affiliation.EntityAffiliation;

 import org.kuali.rice.kim.api.identity.affiliation.EntityAffiliationType;

 import org.kuali.rice.kim.api.identity.citizenship.EntityCitizenship;

 import org.kuali.rice.kim.api.identity.email.EntityEmail;

 import org.kuali.rice.kim.api.identity.employment.EntityEmployment;

 import org.kuali.rice.kim.api.identity.entity.Entity;

 import org.kuali.rice.kim.api.identity.entity.EntityDefault;

 import org.kuali.rice.kim.api.identity.entity.EntityDefaultQueryResults;

 import org.kuali.rice.kim.api.identity.entity.EntityQueryResults;

 import org.kuali.rice.kim.api.identity.external.EntityExternalIdentifier;

 import org.kuali.rice.kim.api.identity.external.EntityExternalIdentifierType;

 import org.kuali.rice.kim.api.identity.name.EntityName;

 import org.kuali.rice.kim.api.identity.name.EntityNameQueryResults;

 import org.kuali.rice.kim.api.identity.personal.EntityBioDemographics;

 import org.kuali.rice.kim.api.identity.personal.EntityEthnicity;

 import org.kuali.rice.kim.api.identity.phone.EntityPhone;

 import org.kuali.rice.kim.api.identity.principal.EntityNamePrincipalName;

 import org.kuali.rice.kim.api.identity.principal.Principal;

 import org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences;

 import org.kuali.rice.kim.api.identity.residency.EntityResidency;

 import org.kuali.rice.kim.api.identity.type.EntityTypeData;

 import org.kuali.rice.kim.api.identity.visa.EntityVisa;

 import org.kuali.rice.kim.api.services.IdentityService;

 import org.kuali.rice.kim.impl.identity.EntityTypeBo;

 import org.kuali.rice.kim.impl.identity.address.EntityAddressBo;

 import org.kuali.rice.kim.impl.identity.address.EntityAddressTypeBo;

 import org.kuali.rice.kim.impl.identity.affiliation.EntityAffiliationBo;

 import org.kuali.rice.kim.impl.identity.affiliation.EntityAffiliationTypeBo;

 import org.kuali.rice.kim.impl.identity.citizenship.EntityCitizenshipBo;

 import org.kuali.rice.kim.impl.identity.citizenship.EntityCitizenshipStatusBo;

 import org.kuali.rice.kim.impl.identity.email.EntityEmailBo;

 import org.kuali.rice.kim.impl.identity.email.EntityEmailTypeBo;

 import org.kuali.rice.kim.impl.identity.employment.EntityEmploymentBo;

 import org.kuali.rice.kim.impl.identity.employment.EntityEmploymentStatusBo;

 import org.kuali.rice.kim.impl.identity.employment.EntityEmploymentTypeBo;

 import org.kuali.rice.kim.impl.identity.entity.EntityBo;

 import org.kuali.rice.kim.impl.identity.external.EntityExternalIdentifierBo;

 import org.kuali.rice.kim.impl.identity.external.EntityExternalIdentifierTypeBo;

 import org.kuali.rice.kim.impl.identity.name.EntityNameBo;

 import org.kuali.rice.kim.impl.identity.name.EntityNameTypeBo;

 import org.kuali.rice.kim.impl.identity.personal.EntityBioDemographicsBo;

 import org.kuali.rice.kim.impl.identity.personal.EntityEthnicityBo;

 import org.kuali.rice.kim.impl.identity.phone.EntityPhoneBo;

 import org.kuali.rice.kim.impl.identity.phone.EntityPhoneTypeBo;

 import org.kuali.rice.kim.impl.identity.principal.PrincipalBo;

 import org.kuali.rice.kim.impl.identity.privacy.EntityPrivacyPreferencesBo;

 import org.kuali.rice.kim.impl.identity.residency.EntityResidencyBo;

 import org.kuali.rice.kim.impl.identity.type.EntityTypeDataBo;

 import org.kuali.rice.kim.impl.identity.visa.EntityVisaBo;

 import org.kuali.rice.kim.service.IdentityUpdateService;

 import org.kuali.rice.kim.util.KIMPropertyConstants;

 import org.kuali.rice.kim.util.KIMWebServiceConstants;

 import org.kuali.rice.krad.service.BusinessObjectService;

 import org.kuali.rice.krad.service.KRADServiceLocatorWeb;

 import javax.jws.WebService;

 import java.util.ArrayList;

 import java.util.Collection;

 import java.util.Collections;

 import java.util.HashMap;

 import java.util.List;

 import java.util.Map;

 import static org.kuali.rice.core.api.criteria.PredicateFactory.*;

 /**

  * 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)

  */

 @WebService(endpointInterface = KIMWebServiceConstants.IdentityService.INTERFACE_CLASS, serviceName = KIMWebServiceConstants.IdentityService.WEB_SERVICE_NAME, portName = KIMWebServiceConstants.IdentityService.WEB_SERVICE_PORT, targetNamespace = KIMWebServiceConstants.MODULE_TARGET_NAMESPACE)

 public class IdentityServiceImpl implements IdentityService, IdentityUpdateService {

     private CriteriaLookupService criteriaLookupService;

         private BusinessObjectService businessObjectService;

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#getEntityInfo(java.lang.String)

          */

         public Entity getEntity(String entityId) {

                 EntityBo entity = getEntityBo( entityId );

                 if ( entity == null ) {

                         return null;

                 }

                 return EntityBo.to( entity );

         }

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#getEntityByPrincipalId(java.lang.String)

          */

         public Entity getEntityByPrincipalId(String principalId) {

                 EntityBo entity = getEntityBoByPrincipalId(principalId);

                 if ( entity == null ) {

                         return null;

                 }

                 return EntityBo.to(entity);

         }

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#getEntityByPrincipalName(java.lang.String)

          */

         public Entity getEntityByPrincipalName(String principalName) {

                 EntityBo entity = getEntityBoByPrincipalName(principalName);

                 if ( entity == null ) {

                         return null;

                 }

                 return EntityBo.to(entity);

         }

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#getEntityDefault(java.lang.String)

          */

         public EntityDefault getEntityDefault(String entityId) {

                 EntityBo entity = getEntityBo( entityId );

                 if ( entity == null ) {

                         return null;

                 }

                 return EntityBo.toDefault( entity );

         }

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#getEntityDefaultByPrincipalId(java.lang.String)

          */

         public EntityDefault getEntityDefaultByPrincipalId(String principalId) {

                 EntityBo entity = getEntityBoByPrincipalId(principalId);

                 if ( entity == null ) {

                         return null;

                 }

                 return EntityBo.toDefault(entity);

         }

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#getEntityDefaultByPrincipalName(java.lang.String)

          */

         public EntityDefault getEntityDefaultByPrincipalName(String principalName) {

                 EntityBo entity = getEntityBoByPrincipalName(principalName);

                 if ( entity == null ) {

                         return null;

                 }

                 return EntityBo.toDefault(entity);

         }

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#getPrincipalByPrincipalNameAndPassword(java.lang.String, java.lang.String)

          */

         @SuppressWarnings("unchecked")

         public Principal getPrincipalByPrincipalNameAndPassword(String principalName, String password) {

                  Map<String,Object> criteria = new HashMap<String,Object>(3);

          criteria.put(KIMPropertyConstants.Principal.PRINCIPAL_NAME, principalName);

          criteria.put(KIMPropertyConstants.Principal.PASSWORD, password);

          criteria.put(KIMPropertyConstants.Principal.ACTIVE, true);

          Collection<PrincipalBo> principals = businessObjectService.findMatching(PrincipalBo.class, criteria);

          if (!principals.isEmpty()) {

              return PrincipalBo.to(principals.iterator().next());

          }

          return null;

         }

     @Override

     public Principal addPrincipalToEntity(Principal principal) {

         if (principal == null) {

             throw new RiceIllegalArgumentException("principal is null");

         }

         if (StringUtils.isEmpty(principal.getEntityId()) || StringUtils.isBlank(principal.getEntityId())

                 || StringUtils.isEmpty(principal.getPrincipalName()) || StringUtils.isBlank(principal.getPrincipalName())) {

             throw new RiceIllegalStateException("Principal's entityId and PrincipalName must be populated before creation");

         }  else {

             if (getPrincipalByPrincipalName(principal.getPrincipalName()) != null) {

                 throw new RiceIllegalStateException("the Principal to create already exists: " + principal);

             }

         }

         PrincipalBo bo = PrincipalBo.from(principal);

         return PrincipalBo.to(businessObjectService.save(bo));

     }

     @Override

     public Principal updatePrincipal(Principal principal) {

         if (principal == null) {

             throw new RiceIllegalArgumentException("principal is null");

         }

         if (StringUtils.isEmpty(principal.getEntityId()) || StringUtils.isBlank(principal.getEntityId())

                 || StringUtils.isEmpty(principal.getPrincipalName()) || StringUtils.isBlank(principal.getPrincipalName())) {

             throw new RiceIllegalStateException("Principal's entityId and PrincipalName must be populated before update");

         }  else {

             if (StringUtils.isEmpty(principal.getPrincipalId()) ||

                     getPrincipalByPrincipalName(principal.getPrincipalName()) == null) {

                 throw new RiceIllegalStateException("the Principal to update does not exist: " + principal);

             }

         }

         PrincipalBo bo = PrincipalBo.from(principal);

         return PrincipalBo.to(businessObjectService.save(bo));

     }

     @Override

     public Principal inactivatePrincipal(String principalId) {

         Principal principal = getPrincipal(principalId);

         if (principal == null) {

             throw new RiceIllegalStateException("Principal with principalId: " + principalId + " does not exist");

         }

         PrincipalBo bo = PrincipalBo.from(principal);

         bo.setActive(false);

         return PrincipalBo.to(businessObjectService.save(bo));

     }

     @Override

     public Principal inactivatePrincipalByName(String principalName) {

         Principal principal = getPrincipalByPrincipalName(principalName);

         if (principal == null) {

             throw new RiceIllegalStateException("Principal with principalName: " + principalName + " does not exist");

         }

         PrincipalBo bo = PrincipalBo.from(principal);

         bo.setActive(false);

         return PrincipalBo.to(businessObjectService.save(bo));

     }

     @Override

     public EntityTypeData addEntityTypeDataToEntity(EntityTypeData entityTypeData) {

         if (entityTypeData == null) {

             throw new RiceIllegalArgumentException("entityTypeData is null");

         }

         if (StringUtils.isEmpty(entityTypeData.getEntityId()) || StringUtils.isBlank(entityTypeData.getEntityId())

                 || StringUtils.isEmpty(entityTypeData.getEntityTypeCode()) || StringUtils.isBlank(entityTypeData.getEntityTypeCode())) {

             throw new RiceIllegalStateException("EntityTypeData's entityId and entityTypeCode must be populated before creation");

         }  else {

             if (getEntityTypeDataBo(entityTypeData.getEntityId(), entityTypeData.getEntityTypeCode()) != null) {

                 throw new RiceIllegalStateException("the entityTypeData to create already exists: " + entityTypeData);

             }

         }

         EntityTypeDataBo bo = EntityTypeDataBo.from(entityTypeData);

         return EntityTypeDataBo.to(businessObjectService.save(bo));

     }

     private EntityTypeDataBo getEntityTypeDataBo(String entityId, String entityTypeCode) {

         Map<String,Object> criteria = new HashMap<String,Object>(3);

          criteria.put(KIMPropertyConstants.Entity.ENTITY_ID, entityId);

          criteria.put(KIMPropertyConstants.Entity.ENTITY_TYPE_CODE, entityTypeCode);

          criteria.put(KIMPropertyConstants.Entity.ACTIVE, true);

          return businessObjectService.findByPrimaryKey(EntityTypeDataBo.class, criteria);

     }

     @Override

     public EntityTypeData updateEntityTypeData(EntityTypeData entityTypeData) {

         if (entityTypeData == null) {

             throw new RiceIllegalArgumentException("entityTypeData is null");

         }

         if (StringUtils.isBlank(entityTypeData.getEntityId()) || StringUtils.isEmpty(entityTypeData.getEntityId())

                 || StringUtils.isBlank(entityTypeData.getEntityTypeCode()) || StringUtils.isEmpty(entityTypeData.getEntityTypeCode())) {

             throw new RiceIllegalStateException("EntityTypeData's entityId and entityTypeCode must be populated before update");

         }  else {

             if (getEntityTypeDataBo(entityTypeData.getEntityId(), entityTypeData.getEntityTypeCode()) == null) {

                 throw new RiceIllegalStateException("the entityTypeData to update does not exist: " + entityTypeData);

             }

         }

         EntityTypeDataBo bo = EntityTypeDataBo.from(entityTypeData);

         return EntityTypeDataBo.to(businessObjectService.save(bo));

     }

     @Override

     public EntityTypeData inactivateEntityTypeData(String entityId, String entityTypeCode) {

         EntityTypeDataBo bo = getEntityTypeDataBo(entityId, entityTypeCode);

         if (bo == null) {

             throw new RiceIllegalStateException("EntityTypeData with entityId: " + entityId + " entityTypeCode: " + entityTypeCode + " does not exist");

         }

         bo.setActive(false);

         return EntityTypeDataBo.to(businessObjectService.save(bo));

     }

     private EntityAddressBo getEntityAddressBo(String entityId, String entityTypeCode, String addressTypeCode) {

         Map<String,Object> criteria = new HashMap<String,Object>(4);

         criteria.put(KIMPropertyConstants.Entity.ENTITY_ID, entityId);

         criteria.put(KIMPropertyConstants.Entity.ENTITY_TYPE_CODE, entityTypeCode);

         criteria.put("addressTypeCode", addressTypeCode);

         criteria.put(KIMPropertyConstants.Entity.ACTIVE, true);

         return businessObjectService.findByPrimaryKey(EntityAddressBo.class, criteria);

     }

     private EntityAddressBo getEntityAddressBo(String addressId) {

         Map<String,Object> criteria = new HashMap<String,Object>(4);

         criteria.put(KIMPropertyConstants.Entity.ID, addressId);

         return businessObjectService.findByPrimaryKey(EntityAddressBo.class, criteria);

     }

     @Override

     public EntityAddress addAddressToEntity(EntityAddress address) {

         if (address == null) {

             throw new RiceIllegalArgumentException("address is null");

         }

         if (StringUtils.isEmpty(address.getEntityId()) || StringUtils.isBlank(address.getEntityId())

                 || StringUtils.isEmpty(address.getEntityTypeCode()) || StringUtils.isBlank(address.getEntityTypeCode())) {

             throw new RiceIllegalStateException("Address's entityId and entityTypeCode must be populated before creation");

         }  else {

             if (address.getAddressType() == null) {

                 throw new RiceIllegalStateException("Address's type must be populated before creation");

             }

             if (getEntityAddressBo(address.getEntityId(), address.getEntityTypeCode(), address.getAddressType().getCode()) != null) {

                 throw new RiceIllegalStateException("the address to create already exists: " + address);

             }

         }

         EntityAddressBo bo = EntityAddressBo.from(address);

         return EntityAddressBo.to(businessObjectService.save(bo));

     }

     @Override

     public EntityAddress updateAddress(EntityAddress address) {

         if (address == null) {

             throw new RiceIllegalArgumentException("address is null");

         }

         if (StringUtils.isEmpty(address.getEntityId()) || StringUtils.isBlank(address.getEntityId())

                 || StringUtils.isEmpty(address.getEntityTypeCode()) || StringUtils.isBlank(address.getEntityTypeCode())) {

             throw new RiceIllegalStateException("Address's entityId and entityTypeCode must be populated before creation");

         }  else {

             if (address.getAddressType() == null) {

                 throw new RiceIllegalStateException("Address's type must be populated before creation");

             }

             if (StringUtils.isEmpty(address.getId())

                   ||  getEntityAddressBo(address.getEntityId(), address.getEntityTypeCode(), address.getAddressType().getCode()) == null) {

                 throw new RiceIllegalStateException("the address to update does not exists: " + address);

             }

         }

         EntityAddressBo bo = EntityAddressBo.from(address);

         return EntityAddressBo.to(businessObjectService.save(bo));

     }

     @Override

     public EntityAddress inactivateAddress(String addressId) {

         EntityAddressBo bo = getEntityAddressBo(addressId);

         if (bo == null) {

             throw new RiceIllegalStateException("Address with addressId: " + addressId + " does not exist");

         }

         bo.setActive(false);

         return EntityAddressBo.to(businessObjectService.save(bo));

     }

     private EntityEmailBo getEntityEmailBo(String entityId, String entityTypeCode, String emailTypeCode) {

         Map<String,Object> criteria = new HashMap<String,Object>(4);

         criteria.put(KIMPropertyConstants.Entity.ENTITY_ID, entityId);

         criteria.put(KIMPropertyConstants.Entity.ENTITY_TYPE_CODE, entityTypeCode);

         criteria.put("emailTypeCode", emailTypeCode);

         criteria.put(KIMPropertyConstants.Entity.ACTIVE, true);

         return businessObjectService.findByPrimaryKey(EntityEmailBo.class, criteria);

     }

     private EntityEmailBo getEntityEmailBo(String emailId) {

         Map<String,Object> criteria = new HashMap<String,Object>(4);

         criteria.put(KIMPropertyConstants.Entity.ID, emailId);

         return businessObjectService.findByPrimaryKey(EntityEmailBo.class, criteria);

     }

     @Override

     public EntityEmail addEmailToEntity(EntityEmail email) {

         if (email == null) {

             throw new RiceIllegalArgumentException("email is null");

         }

         if (StringUtils.isEmpty(email.getEntityId()) || StringUtils.isBlank(email.getEntityId())

                 || StringUtils.isEmpty(email.getEntityTypeCode()) || StringUtils.isBlank(email.getEntityTypeCode())) {

             throw new RiceIllegalStateException("Email's entityId and entityTypeCode must be populated before creation");

         }  else {

             if (email.getEmailType() == null) {

                 throw new RiceIllegalStateException("Email's type must be populated before creation");

             }

             if (getEntityEmailBo(email.getEntityId(), email.getEntityTypeCode(), email.getEmailType().getCode()) != null) {

                 throw new RiceIllegalStateException("the email to create already exists: " + email);

             }

         }

         EntityEmailBo bo = EntityEmailBo.from(email);

         return EntityEmailBo.to(businessObjectService.save(bo));

     }

     @Override

     public EntityEmail updateEmail(EntityEmail email) {

         if (email == null) {

             throw new RiceIllegalArgumentException("email is null");

         }

         if (StringUtils.isEmpty(email.getEntityId()) || StringUtils.isBlank(email.getEntityId())

                 || StringUtils.isEmpty(email.getEntityTypeCode()) || StringUtils.isBlank(email.getEntityTypeCode())) {

             throw new RiceIllegalStateException("Email's entityId and entityTypeCode must be populated before creation");

         }  else {

             if (email.getEmailType() == null) {

                 throw new RiceIllegalStateException("Email's type must be populated before creation");

             }

             if (StringUtils.isEmpty(email.getId())

                   ||  getEntityEmailBo(email.getEntityId(), email.getEntityTypeCode(), email.getEmailType().getCode()) == null) {

                 throw new RiceIllegalStateException("the email to update does not exists: " + email);

             }

         }

         EntityEmailBo bo = EntityEmailBo.from(email);

         return EntityEmailBo.to(businessObjectService.save(bo));

     }

     @Override

     public EntityEmail inactivateEmail(String emailId) {

         EntityEmailBo bo = getEntityEmailBo(emailId);

         if (bo == null) {

             throw new RiceIllegalStateException("Email with emailId: " + emailId + " does not exist");

         }

         bo.setActive(false);

         return EntityEmailBo.to(businessObjectService.save(bo));

     }

     private EntityPhoneBo getEntityPhoneBo(String entityId, String entityTypeCode, String phoneTypeCode) {

         Map<String,Object> criteria = new HashMap<String,Object>(4);

         criteria.put(KIMPropertyConstants.Entity.ENTITY_ID, entityId);

         criteria.put(KIMPropertyConstants.Entity.ENTITY_TYPE_CODE, entityTypeCode);

         criteria.put("phoneTypeCode", phoneTypeCode);

         criteria.put(KIMPropertyConstants.Entity.ACTIVE, true);

         return businessObjectService.findByPrimaryKey(EntityPhoneBo.class, criteria);

     }

     private EntityPhoneBo getEntityPhoneBo(String phoneId) {

         Map<String,Object> criteria = new HashMap<String,Object>(4);

         criteria.put(KIMPropertyConstants.Entity.ID, phoneId);

         return businessObjectService.findByPrimaryKey(EntityPhoneBo.class, criteria);

     }

     @Override

     public EntityPhone addPhoneToEntity(EntityPhone phone) {

         if (phone == null) {

             throw new RiceIllegalArgumentException("phone is null");

         }

         if (StringUtils.isEmpty(phone.getEntityId()) || StringUtils.isBlank(phone.getEntityId())

                 || StringUtils.isEmpty(phone.getEntityTypeCode()) || StringUtils.isBlank(phone.getEntityTypeCode())) {

             throw new RiceIllegalStateException("Phone's entityId and entityTypeCode must be populated before creation");

         }  else {

             if (phone.getPhoneType() == null) {

                 throw new RiceIllegalStateException("Phone's type must be populated before creation");

             }

             if (getEntityPhoneBo(phone.getEntityId(), phone.getEntityTypeCode(), phone.getPhoneType().getCode()) != null) {

                 throw new RiceIllegalStateException("the phone to create already exists: " + phone);

             }

         }

         EntityPhoneBo bo = EntityPhoneBo.from(phone);

         return EntityPhoneBo.to(businessObjectService.save(bo));

     }

     @Override

     public EntityPhone updatePhone(EntityPhone phone) {

         if (phone == null) {

             throw new RiceIllegalArgumentException("phone is null");

         }

         if (StringUtils.isEmpty(phone.getEntityId()) || StringUtils.isBlank(phone.getEntityId())

                 || StringUtils.isEmpty(phone.getEntityTypeCode()) || StringUtils.isBlank(phone.getEntityTypeCode())) {

             throw new RiceIllegalStateException("Phone's entityId and entityTypeCode must be populated before creation");

         }  else {

             if (phone.getPhoneType() == null) {

                 throw new RiceIllegalStateException("Phone's type must be populated before creation");

             }

             if (StringUtils.isEmpty(phone.getId())

                   ||  getEntityPhoneBo(phone.getEntityId(), phone.getEntityTypeCode(), phone.getPhoneType().getCode()) == null) {

                 throw new RiceIllegalStateException("the phone to update does not exists: " + phone);

             }

         }

         EntityPhoneBo bo = EntityPhoneBo.from(phone);

         return EntityPhoneBo.to(businessObjectService.save(bo));

     }

     @Override

     public EntityPhone inactivatePhone(String phoneId) {

         EntityPhoneBo bo = getEntityPhoneBo(phoneId);

         if (bo == null) {

             throw new RiceIllegalStateException("Phone with phoneId: " + phoneId + " does not exist");

         }

         bo.setActive(false);

         return EntityPhoneBo.to(businessObjectService.save(bo));

     }

     private EntityExternalIdentifierBo getEntityExternalIdentifierBo(String entityId, String externalIdentifierTypeCode) {

         Map<String,Object> criteria = new HashMap<String,Object>(4);

         criteria.put(KIMPropertyConstants.Entity.ENTITY_ID, entityId);

         criteria.put("externalIdentifierTypeCode", externalIdentifierTypeCode);

         return businessObjectService.findByPrimaryKey(EntityExternalIdentifierBo.class, criteria);

     }

     @Override

     public EntityExternalIdentifier addExternalIdentifierToEntity(EntityExternalIdentifier externalId) {

         if (externalId == null) {

             throw new RiceIllegalArgumentException("externalId is null");

         }

         if (StringUtils.isEmpty(externalId.getEntityId()) || StringUtils.isBlank(externalId.getEntityId())

                 || StringUtils.isEmpty(externalId.getExternalIdentifierTypeCode()) || StringUtils.isBlank(externalId.getExternalIdentifierTypeCode())) {

             throw new RiceIllegalStateException("EntityExternalIdentifier's entityId and entityTypeCode must be populated before creation");

         }  else {

             if (getEntityExternalIdentifierBo(externalId.getEntityId(), externalId.getExternalIdentifierTypeCode()) != null) {

                 throw new RiceIllegalStateException("the EntityExternalIdentifier to create already exists: " + externalId);

             }

         }

         EntityExternalIdentifierBo bo = EntityExternalIdentifierBo.from(externalId);

         return EntityExternalIdentifierBo.to(businessObjectService.save(bo));

     }

     @Override

     public EntityExternalIdentifier updateExternalIdentifier(EntityExternalIdentifier externalId) {

         if (externalId == null) {

             throw new RiceIllegalArgumentException("externalId is null");

         }

         if (StringUtils.isEmpty(externalId.getEntityId()) || StringUtils.isBlank(externalId.getEntityId())

                 || StringUtils.isEmpty(externalId.getExternalIdentifierTypeCode()) || StringUtils.isBlank(externalId.getExternalIdentifierTypeCode())) {

             throw new RiceIllegalStateException("EntityExternalIdentifier's entityId and externalIdentifierTypeCode must be populated before creation");

         }  else {

             if (StringUtils.isEmpty(externalId.getId())

                   ||  getEntityExternalIdentifierBo(externalId.getEntityId(), externalId.getExternalIdentifierTypeCode()) == null) {

                 throw new RiceIllegalStateException("the external identifier to update does not exist: " + externalId);

             }

         }

         EntityExternalIdentifierBo bo = EntityExternalIdentifierBo.from(externalId);

         return EntityExternalIdentifierBo.to(businessObjectService.save(bo));

     }

     private EntityAffiliationBo getEntityAffiliationBo(String id) {

         Map<String,Object> criteria = new HashMap<String,Object>();

         criteria.put(KIMPropertyConstants.Entity.ID, id);

         return businessObjectService.findByPrimaryKey(EntityAffiliationBo.class, criteria);

     }

     @Override

     public EntityAffiliation addAffiliationToEntity(EntityAffiliation affiliation) {

         if (affiliation == null) {

             throw new RiceIllegalArgumentException("affiliation is null");

         }

         if (StringUtils.isEmpty(affiliation.getEntityId()) || StringUtils.isBlank(affiliation.getEntityId())) {

             throw new RiceIllegalStateException("Affiliation's entityId must be populated before creation");

         }  else {

             if (affiliation.getAffiliationType() == null) {

                 throw new RiceIllegalStateException("EntityAffiliation's type must be populated before creation");

             }

             if (getEntityAffiliationBo(affiliation.getId()) != null) {

                 throw new RiceIllegalStateException("the EntityAffiliation to create already exists: " + affiliation);

             }

         }

         EntityAffiliationBo bo = EntityAffiliationBo.from(affiliation);

         return EntityAffiliationBo.to(businessObjectService.save(bo));

     }

     @Override

     public EntityAffiliation updateAffiliation(EntityAffiliation affiliation) {

         if (affiliation == null) {

             throw new RiceIllegalArgumentException("affiliation is null");

         }

         if (StringUtils.isEmpty(affiliation.getEntityId()) || StringUtils.isBlank(affiliation.getEntityId())) {

             throw new RiceIllegalStateException("Affiliation's entityId must be populated before creation");

         }  else {

             if (affiliation.getAffiliationType() == null) {

                 throw new RiceIllegalStateException("EntityAffiliation's type must be populated before creation");

             }

             if (StringUtils.isEmpty(affiliation.getId())

                   ||  getEntityAffiliationBo(affiliation.getId()) == null) {

                 throw new RiceIllegalStateException("the EntityAffiliation to update already exists: " + affiliation);

             }

         }

         EntityAffiliationBo bo = EntityAffiliationBo.from(affiliation);

         return EntityAffiliationBo.to(businessObjectService.save(bo));

     }

     @Override

     public EntityAffiliation inactivateAffiliation(String id) {

         EntityAffiliationBo bo = getEntityAffiliationBo(id);

         if (bo == null) {

             throw new RiceIllegalStateException("EntityAffiliation with id: " + id + " does not exist");

         }

         bo.setActive(false);

         return EntityAffiliationBo.to(businessObjectService.save(bo));

     }

     /**

          * @see org.kuali.rice.kim.api.services.IdentityService#findEntities(org.kuali.rice.core.api.criteria.QueryByCriteria)

          */

         @SuppressWarnings("unchecked")

         public EntityQueryResults findEntities(QueryByCriteria queryByCriteria) {

                 if (queryByCriteria == null) {

             throw new RiceIllegalArgumentException("queryByCriteria is null");

         }

         GenericQueryResults<EntityBo> results = criteriaLookupService.lookup(EntityBo.class, queryByCriteria);

         EntityQueryResults.Builder builder = EntityQueryResults.Builder.create();

         builder.setMoreResultsAvailable(results.isMoreResultsAvailable());

         builder.setTotalRowCount(results.getTotalRowCount());

         final List<Entity.Builder> ims = new ArrayList<Entity.Builder>();

         for (EntityBo bo : results.getResults()) {

             ims.add(Entity.Builder.create(bo));

         }

         builder.setResults(ims);

         return builder.build();

         }

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#findEntityDefault(Map, boolean)

          */

         @SuppressWarnings("unchecked")

         public EntityDefaultQueryResults findEntityDefaults(QueryByCriteria queryByCriteria) {

                 if (queryByCriteria == null) {

             throw new RiceIllegalArgumentException("queryByCriteria is null");

         }

         GenericQueryResults<EntityBo> results = criteriaLookupService.lookup(EntityBo.class, queryByCriteria);

         EntityDefaultQueryResults.Builder builder = EntityDefaultQueryResults.Builder.create();

         builder.setMoreResultsAvailable(results.isMoreResultsAvailable());

         builder.setTotalRowCount(results.getTotalRowCount());

         final List<EntityDefault.Builder> ims = new ArrayList<EntityDefault.Builder>();

         for (EntityBo bo : results.getResults()) {

             ims.add(EntityDefault.Builder.create(bo));

         }

         builder.setResults(ims);

         return builder.build();

         }

     /**

          * @see org.kuali.rice.kim.api.services.IdentityService#findEntity(Map, boolean)

          */

         @SuppressWarnings("unchecked")

         public EntityNameQueryResults findNames(QueryByCriteria queryByCriteria) {

                 if (queryByCriteria == null) {

             throw new RiceIllegalArgumentException("queryByCriteria is null");

         }

         GenericQueryResults<EntityNameBo> results = criteriaLookupService.lookup(EntityNameBo.class, queryByCriteria);

         EntityNameQueryResults.Builder builder = EntityNameQueryResults.Builder.create();

         builder.setMoreResultsAvailable(results.isMoreResultsAvailable());

         builder.setTotalRowCount(results.getTotalRowCount());

         final List<EntityName.Builder> ims = new ArrayList<EntityName.Builder>();

         for (EntityNameBo bo : results.getResults()) {

             ims.add(EntityName.Builder.create(bo));

         }

         builder.setResults(ims);

         return builder.build();

         }

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#getEntityPrivacyPreferences(java.lang.String)

          */

         public EntityPrivacyPreferences getEntityPrivacyPreferences(String entityId) {

         if (StringUtils.isEmpty(entityId)) {

             return null;

         }

                 Map<String,String> criteria = new HashMap<String,String>(1);

         criteria.put(KIMPropertyConstants.Entity.ENTITY_ID, entityId);

                 return EntityPrivacyPreferencesBo.to(businessObjectService.findByPrimaryKey(EntityPrivacyPreferencesBo.class, criteria));

         }

     /**

          * @see org.kuali.rice.kim.api.services.IdentityService#getPrincipal(java.lang.String)

          */

         public Principal getPrincipal(String principalId) {

                 PrincipalBo principal = getPrincipalBo(principalId);

                 if ( principal == null ) {

                         return null;

                 }

                 return PrincipalBo.to(principal);

         }

         private PrincipalBo getPrincipalBo(String principalId) {

                 Map<String,String> criteria = new HashMap<String,String>(1);

         criteria.put(KIMPropertyConstants.Principal.PRINCIPAL_ID, principalId);

                 return businessObjectService.findByPrimaryKey(PrincipalBo.class, criteria);

         }

         private EntityBo getEntityBo(String entityId) {

                 EntityBo entityImpl = businessObjectService.findByPrimaryKey(EntityBo.class, Collections.singletonMap("id", entityId));

         if(entityImpl!=null) {

                 entityImpl.refresh();

             /*TODO: We need to try and remove this.  Currently, without it, some integration tests fail because of some

              * sort of OJB caching and not filling in the type values.  We need to figure out why this is happening and fix it.

              * Yes, this is a hack :P

              */

             for (EntityTypeDataBo type : entityImpl.getEntityTypes()) {

                 type.refresh();

                 for (EntityAddressBo addressBo : type.getAddresses()) {

                     addressBo.refreshReferenceObject("addressType");

                 }

                 for (EntityEmailBo emailBo : type.getEmailAddresses()) {

                     emailBo.refreshReferenceObject("emailType");

                 }

                 for (EntityPhoneBo phoneBo : type.getPhoneNumbers()) {

                     phoneBo.refreshReferenceObject("phoneType");

                 }

             }

             for (EntityNameBo name : entityImpl.getNames()) {

                 name.refreshReferenceObject("nameType");

             }

         }

         return entityImpl;

         }

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#lookupEntitys(java.util.Map)

          */

         @SuppressWarnings("unchecked")

         protected List<EntityBo> lookupEntitys(Map<String, String> searchCriteria) {

                 return new ArrayList(KRADServiceLocatorWeb.getLookupService().findCollectionBySearchUnbounded( EntityBo.class, searchCriteria ));

         }

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#lookupEntityIds(java.util.Map)

          */

         public List<String> lookupEntityIds(Map<String,String> searchCriteria) {

                 List<EntityBo> entities = lookupEntitys( searchCriteria );

                 List<String> entityIds = new ArrayList<String>( entities.size() );

                 for ( EntityBo entity : entities ) {

                         entityIds.add( entity.getId() );

                 }

                 return entityIds;

         }

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#getPrincipalByPrincipalName(java.lang.String)

          */

         @SuppressWarnings("unchecked")

         public Principal getPrincipalByPrincipalName(String principalName) {

                 if ( StringUtils.isBlank(principalName) ) {

                         return null;

                 }

                 Map<String,Object> criteria = new HashMap<String,Object>(1);

         criteria.put(KIMPropertyConstants.Principal.PRINCIPAL_NAME, principalName.toLowerCase());

         Collection<PrincipalBo> principals = businessObjectService.findMatching(PrincipalBo.class, criteria);

         if (!principals.isEmpty() && principals.size() == 1) {

             return PrincipalBo.to(principals.iterator().next());

         }

         return null;

     }

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#getEntityByPrincipalName(java.lang.String)

          */

         protected EntityBo getEntityBoByPrincipalName(String principalName) {

                 if ( StringUtils.isBlank( principalName ) ) {

                         return null;

                 }

         return getEntityByKeyValue("principals." + KIMPropertyConstants.Principal.PRINCIPAL_NAME, principalName.toLowerCase());

         }

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#getEntityByPrincipalId(java.lang.String)

          */

         protected EntityBo getEntityBoByPrincipalId(String principalId) {

                 if ( StringUtils.isBlank( principalId ) ) {

                         return null;

                 }

         return getEntityByKeyValue("principals." + KIMPropertyConstants.Principal.PRINCIPAL_ID, principalId);

         }

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#getEntityIdByPrincipalId(java.lang.String)

          */

         public String getEntityIdByPrincipalId(String principalId) {

                 if ( StringUtils.isBlank( principalId ) ) {

                         return null;

                 }

                 PrincipalBo principal = getPrincipalBo(principalId);

                 return principal != null ? principal.getEntityId() : null;

     }

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#getEntityIdByPrincipalName(java.lang.String)

          */

         public String getEntityIdByPrincipalName(String principalName) {

                 if ( StringUtils.isBlank( principalName ) ) {

                         return null;

                 }

                 Principal principal = getPrincipalByPrincipalName(principalName);

                 return principal != null ? principal.getEntityId() : null;

     }

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#getPrincipalIdByPrincipalName(java.lang.String)

          */

         public String getPrincipalIdByPrincipalName(String principalName) {

                 if ( StringUtils.isBlank( principalName ) ) {

                         return null;

                 }

                 Principal principal = getPrincipalByPrincipalName( principalName );

                 return principal != null ? principal.getPrincipalId() : null;

         }

         /**

          * @see org.kuali.rice.kim.api.services.IdentityService#getDefaultNamesForEntityIds(java.util.List)

          */

         public Map<String, EntityNamePrincipalName> getDefaultNamesForEntityIds(List<String> entityIds) {

                 Map<String, EntityNamePrincipalName> result = new HashMap<String, EntityNamePrincipalName>(entityIds.size());

         if (CollectionUtils.isEmpty(entityIds)) {

             return result;

         }

         final QueryByCriteria.Builder builder = QueryByCriteria.Builder.create();

         builder.setPredicates(and(in("id", entityIds.toArray()),

                                   equal("active", "Y"),

                                   and(

                                     equal("names.active", "Y"),

                                     equal("names.defaultValue", "Y"))));

         EntityDefaultQueryResults qr = findEntityDefaults(builder.build());

         for(EntityDefault entityDefault : qr.getResults()) {

             for (Principal principal : entityDefault.getPrincipals()) {

                 result.put(entityDefault.getEntityId(), EntityNamePrincipalName.Builder

                         .create(principal.getPrincipalName(), EntityName.Builder.create(entityDefault.getName()))

                         .build());

                 break;

             }

                 }

                 return result;

         }

     /**

          * @see org.kuali.rice.kim.api.services.IdentityService#getDefaultNamesForPrincipalIds(java.util.List)

          */

         public Map<String, EntityNamePrincipalName> getDefaultNamesForPrincipalIds(List<String> principalIds) {

                 Map<String, EntityNamePrincipalName> result = new HashMap<String, EntityNamePrincipalName>();

         QueryByCriteria.Builder qb = QueryByCriteria.Builder.create();

         qb.setPredicates(and(in("principals.principalId", principalIds.toArray()),

                              equal("active", "Y"),

                              equal("names.defaultValue", "Y")));

         List<EntityDefault> entityDefaults = findEntityDefaults(qb.build()).getResults();

                 for(EntityDefault entityDefault : entityDefaults) {

             for (Principal principal : entityDefault.getPrincipals()) {

                 result.put(principal.getPrincipalId(), EntityNamePrincipalName.Builder

                         .create(principal.getPrincipalName(), EntityName.Builder.create(entityDefault.getName()))

                         .build());

             }

                 }

                 return result;

         }

         /**

          * Generic helper method for performing a lookup through the business object service.

          */

         @SuppressWarnings("unchecked")

         protected EntityBo getEntityByKeyValue(String key, String value) {

                 Map<String,String> criteria = new HashMap<String,String>(1);

         criteria.put(key, value);

         Collection<EntityBo> entities = businessObjectService.findMatching(EntityBo.class, criteria);

         if (entities.size() >= 1) {

                 return entities.iterator().next();

         }

                 return null;

         }

         public Type getAddressType( String code ) {

                 EntityAddressTypeBo impl = businessObjectService.findBySinglePrimaryKey(EntityAddressTypeBo.class, code);

                 if ( impl == null ) {

                         return null;

                 }

                 return EntityAddressTypeBo.to(impl);

         }

     public EntityAffiliationType getAffiliationType( String code ) {

                 EntityAffiliationTypeBo impl = businessObjectService.findBySinglePrimaryKey(EntityAffiliationTypeBo.class, code);

                 if ( impl == null ) {

                         return null;

                 }

                 return EntityAffiliationTypeBo.to(impl);

         }

     public Type getCitizenshipStatus( String code ) {

                 EntityCitizenshipStatusBo impl = businessObjectService.findBySinglePrimaryKey(EntityCitizenshipStatusBo.class, code);

                 if ( impl == null ) {

                         return null;

                 }

                 return EntityCitizenshipStatusBo.to(impl);

         }

     public Type getEmailType( String code ) {

                 EntityEmailTypeBo impl = businessObjectService.findBySinglePrimaryKey(EntityEmailTypeBo.class, code);

                 if ( impl == null ) {

                         return null;

                 }

                 return EntityEmailTypeBo.to(impl);

         }

     public Type getEmploymentStatus( String code ) {

                 EntityEmploymentStatusBo impl = businessObjectService.findBySinglePrimaryKey(EntityEmploymentStatusBo.class, code);

                 if ( impl == null ) {

                         return null;

                 }

                 return EntityEmploymentStatusBo.to(impl);

         }

     public Type getEmploymentType( String code ) {

                 EntityEmploymentTypeBo impl = businessObjectService.findBySinglePrimaryKey(EntityEmploymentTypeBo.class, code);

                 if ( impl == null ) {

                         return null;

                 }

                 return EntityEmploymentTypeBo.to(impl);

         }

     public Type getNameType(String code) {

                 EntityNameTypeBo impl = businessObjectService.findBySinglePrimaryKey(EntityNameTypeBo.class, code);

                 if ( impl == null ) {

                         return null;

                 }

                 return EntityNameTypeBo.to(impl);

         }

     public Type getEntityType( String code ) {

                 EntityTypeBo impl = businessObjectService.findBySinglePrimaryKey(EntityTypeBo.class, code);

                 if ( impl == null ) {

                         return null;

                 }

                 return EntityTypeBo.to(impl);

         }

     public EntityExternalIdentifierType getExternalIdentifierType( String code ) {

                 EntityExternalIdentifierTypeBo impl = businessObjectService.findBySinglePrimaryKey(EntityExternalIdentifierTypeBo.class, code);

                 if ( impl == null ) {

                         return null;

                 }

                 return EntityExternalIdentifierTypeBo.to(impl);

         }

     public Type getPhoneType( String code ) {

                 EntityPhoneTypeBo impl = businessObjectService.findBySinglePrimaryKey(EntityPhoneTypeBo.class, code);

                 if ( impl == null ) {

                         return null;

                 }

                 return EntityPhoneTypeBo.to(impl);

         }

     @Override

     public Entity createEntity(Entity entity) {

         if (entity == null) {

             throw new RiceIllegalArgumentException("entity is null");

         }

         if (StringUtils.isNotBlank(entity.getId()) && getEntity(entity.getId()) != null) {

             throw new RiceIllegalStateException("the Entity to create already exists: " + entity);

         }

         EntityBo bo = EntityBo.from(entity);

         return EntityBo.to(businessObjectService.save(bo));

     }

     @Override

     public Entity updateEntity(Entity entity) {

         if (entity == null) {

             throw new RiceIllegalArgumentException("entity is null");

         }

         if (StringUtils.isBlank(entity.getId()) || getEntity(entity.getId()) == null) {

             throw new RiceIllegalStateException("the Entity does not exist: " + entity);

         }

         EntityBo bo = EntityBo.from(entity);

         return EntityBo.to(businessObjectService.save(bo));

     }

     @Override

     public Entity inactivateEntity(String entityId) {

          if (StringUtils.isEmpty(entityId)) {

             throw new RiceIllegalArgumentException("entityId is empty");

         }

         Entity entity = getEntity(entityId);

         if (entity == null) {

             throw new RiceIllegalStateException("an Entity does not exist for entityId: " + entityId);

         }

         EntityBo bo = EntityBo.from(entity);

         bo.setActive(false);

         return EntityBo.to(businessObjectService.save(bo));

     }

     @Override

     public EntityPrivacyPreferences addPrivacyPreferencesToEntity(EntityPrivacyPreferences privacyPreferences) {

         if (privacyPreferences == null) {

             throw new RiceIllegalArgumentException("privacyPreferences is null");

         }

         if (StringUtils.isEmpty(privacyPreferences.getEntityId()) || StringUtils.isBlank(privacyPreferences.getEntityId())) {

             throw new RiceIllegalStateException("PrivacyPreferences' entityId must be populated before creation");

         }  else {

             if (getEntityPrivacyPreferences(privacyPreferences.getEntityId()) != null) {

                 throw new RiceIllegalStateException("the PrivacyPreferences to create already exists: " + privacyPreferences);

             }

         }

         EntityPrivacyPreferencesBo bo = EntityPrivacyPreferencesBo.from(privacyPreferences);

         return EntityPrivacyPreferencesBo.to(businessObjectService.save(bo));

     }

     @Override

     public EntityPrivacyPreferences updatePrivacyPreferences(EntityPrivacyPreferences privacyPreferences) {

         if (privacyPreferences == null) {

             throw new RiceIllegalArgumentException("privacyPreferences is null");

         }

         if (StringUtils.isEmpty(privacyPreferences.getEntityId()) || StringUtils.isBlank(privacyPreferences.getEntityId())) {

             throw new RiceIllegalStateException("PrivacyPreferences' entityId must be populated before update");

         }  else {

             if (getEntityPrivacyPreferences(privacyPreferences.getEntityId()) == null) {

                 throw new RiceIllegalStateException("the PrivacyPreferences to update does not exist: " + privacyPreferences);

             }

         }

         EntityPrivacyPreferencesBo bo = EntityPrivacyPreferencesBo.from(privacyPreferences);

         return EntityPrivacyPreferencesBo.to(businessObjectService.save(bo));

     }

     private EntityCitizenshipBo getEntityCitizenshipBo(String entityId, String citizenshipStatusCode) {

         if (StringUtils.isEmpty(entityId) || StringUtils.isEmpty(citizenshipStatusCode)) {

             return null;

         }

         Map<String,Object> criteria = new HashMap<String,Object>(4);

         criteria.put(KIMPropertyConstants.Entity.ENTITY_ID, entityId);

         criteria.put("statusCode", citizenshipStatusCode);

         criteria.put(KIMPropertyConstants.Entity.ACTIVE, true);

         return businessObjectService.findByPrimaryKey(EntityCitizenshipBo.class, criteria);

     }

     private EntityCitizenshipBo getEntityCitizenshipBo(String id) {

         if (StringUtils.isEmpty(id)) {

             return null;

         }

         Map<String,Object> criteria = new HashMap<String,Object>();

         criteria.put(KIMPropertyConstants.Entity.ID, id);

         criteria.put(KIMPropertyConstants.Entity.ACTIVE, true);

         return businessObjectService.findByPrimaryKey(EntityCitizenshipBo.class, criteria);

     }

     @Override

     public EntityCitizenship addCitizenshipToEntity(EntityCitizenship citizenship) {

         if (citizenship == null) {

             throw new RiceIllegalArgumentException("citizenship is null");

         }

         if (StringUtils.isEmpty(citizenship.getEntityId()) || StringUtils.isBlank(citizenship.getEntityId())) {

             throw new RiceIllegalStateException("Citizenship's entityId must be populated before creation");

         }  else {

             if (citizenship.getStatus() == null) {

                 throw new RiceIllegalStateException("Citizenship's status must be populated before creation");

             }

             if (getEntityCitizenshipBo(citizenship.getEntityId(), citizenship.getStatus().getCode()) != null) {

                 throw new RiceIllegalStateException("the EntityCitizenship to create already exists: " + citizenship);

             }

         }

         EntityCitizenshipBo bo = EntityCitizenshipBo.from(citizenship);

         return EntityCitizenshipBo.to(businessObjectService.save(bo));

     }

     @Override

     public EntityCitizenship updateCitizenship(EntityCitizenship citizenship) {

         if (citizenship == null) {

             throw new RiceIllegalArgumentException("citizenship is null");

         }

         if (StringUtils.isEmpty(citizenship.getEntityId()) || StringUtils.isBlank(citizenship.getEntityId())) {

             throw new RiceIllegalStateException("Email's entityId must be populated before creation");

         }  else {

             if (citizenship.getStatus() == null) {

                 throw new RiceIllegalStateException("Citizenship's status must be populated before creation");

             }

             if (getEntityCitizenshipBo(citizenship.getEntityId(), citizenship.getStatus().getCode()) == null) {

                 throw new RiceIllegalStateException("the EntityCitizenship to update does not exist: " + citizenship);

             }

         }

         EntityCitizenshipBo bo = EntityCitizenshipBo.from(citizenship);

         return EntityCitizenshipBo.to(businessObjectService.save(bo));

     }

     @Override

     public EntityCitizenship inactivateCitizenship(String id) {

         if (StringUtils.isEmpty(id)) {

             throw new RiceIllegalArgumentException("id is empty");

         }

         EntityCitizenshipBo bo = getEntityCitizenshipBo(id);

         if (bo == null) {

             throw new RiceIllegalStateException("the EntityCitizenship with id: " + id + " does not exist");

         }

         bo.setActive(false);

         return EntityCitizenshipBo.to(businessObjectService.save(bo));

     }

     private EntityEthnicityBo getEntityEthnicityBo(String ethnicityId) {

         if (StringUtils.isEmpty(ethnicityId)) {

             return null;

         }

         Map<String,Object> criteria = new HashMap<String,Object>();

         criteria.put(KIMPropertyConstants.Entity.ID, ethnicityId);

         return businessObjectService.findByPrimaryKey(EntityEthnicityBo.class, criteria);

     }

     @Override

     public EntityEthnicity addEthnicityToEntity(EntityEthnicity ethnicity) {

         if (ethnicity == null) {

             throw new RiceIllegalArgumentException("ethnicity is null");

         }

         if (StringUtils.isEmpty(ethnicity.getEntityId()) || StringUtils.isBlank(ethnicity.getEntityId())) {

             throw new RiceIllegalStateException("Ethnicity's entityId must be populated before creation");

         }  else {

             if (StringUtils.isNotEmpty(ethnicity.getId()) && getEntityEthnicityBo(ethnicity.getId()) != null) {

                 throw new RiceIllegalStateException("the EntityEthnicity to create already exists: " + ethnicity);

             }

         }

         EntityEthnicityBo bo = EntityEthnicityBo.from(ethnicity);

         return EntityEthnicityBo.to(businessObjectService.save(bo));

     }

     @Override

     public EntityEthnicity updateEthnicity(EntityEthnicity ethnicity) {

         if (ethnicity == null) {

             throw new RiceIllegalArgumentException("ethnicity is null");

         }

         if (StringUtils.isEmpty(ethnicity.getEntityId()) || StringUtils.isBlank(ethnicity.getEntityId())) {

             throw new RiceIllegalStateException("Ethnicity's entityId must be populated before creation");

         }  else {

             if (StringUtils.isEmpty(ethnicity.getId()) || getEntityEthnicityBo(ethnicity.getId()) == null) {

                 throw new RiceIllegalStateException("the EntityEthnicity to update does not exist: " + ethnicity);

             }

         }

         EntityEthnicityBo bo = EntityEthnicityBo.from(ethnicity);

         return EntityEthnicityBo.to(businessObjectService.save(bo));

     }

     private EntityResidencyBo getEntityResidencyBo(String residencyId) {

         if (StringUtils.isEmpty(residencyId)) {

             return null;

         }

         Map<String,Object> criteria = new HashMap<String,Object>();

         criteria.put(KIMPropertyConstants.Entity.ID, residencyId);

         return businessObjectService.findByPrimaryKey(EntityResidencyBo.class, criteria);

     }

     @Override

     public EntityResidency addResidencyToEntity(EntityResidency residency) {

         if (residency == null) {

             throw new RiceIllegalArgumentException("residency is null");

         }

         if (StringUtils.isEmpty(residency.getEntityId()) || StringUtils.isBlank(residency.getEntityId())) {

             throw new RiceIllegalStateException("Residency's entityId must be populated before creation");

         }  else {

             if (StringUtils.isNotEmpty(residency.getId()) && getEntityResidencyBo(residency.getId()) != null) {

                 throw new RiceIllegalStateException("the EntityResidency to create already exists: " + residency);

             }

         }

         EntityResidencyBo bo = EntityResidencyBo.from(residency);

         return EntityResidencyBo.to(businessObjectService.save(bo));

     }

     @Override

     public EntityResidency updateResidency(EntityResidency residency) {

         if (residency == null) {

             throw new RiceIllegalArgumentException("residency is null");

         }

         if (StringUtils.isEmpty(residency.getEntityId()) || StringUtils.isBlank(residency.getEntityId())) {

             throw new RiceIllegalStateException("Residency's entityId must be populated before creation");

         }  else {

             if (StringUtils.isEmpty(residency.getId()) || getEntityResidencyBo(residency.getId()) == null) {

                 throw new RiceIllegalStateException("the EntityResidency to update does not exist: " + residency);

             }

         }

         EntityResidencyBo bo = EntityResidencyBo.from(residency);

         return EntityResidencyBo.to(businessObjectService.save(bo));

     }

     private EntityVisaBo getEntityVisaBo(String visaId) {

         if (StringUtils.isEmpty(visaId)) {

             return null;

         }

         Map<String,Object> criteria = new HashMap<String,Object>();

         criteria.put(KIMPropertyConstants.Entity.ID, visaId);