Coverage Report

Coverage Report - org.kuali.rice.kim.bo.impl.PersonImpl

Classes in this File

Line Coverage

Branch Coverage

Complexity

PersonImpl

0/254

0/86

1.814

 /*
  * Copyright 2007-2008 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.bo.impl;
 
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
 import org.kuali.rice.core.util.type.KualiDecimal;
 import org.kuali.rice.kim.bo.Person;
 import org.kuali.rice.kim.bo.entity.KimEntityAddress;
 import org.kuali.rice.kim.bo.entity.KimEntityAffiliation;
 import org.kuali.rice.kim.bo.entity.KimEntityEmail;
 import org.kuali.rice.kim.bo.entity.KimEntityEmploymentInformation;
 import org.kuali.rice.kim.bo.entity.KimEntityExternalIdentifier;
 import org.kuali.rice.kim.bo.entity.KimEntityName;
 import org.kuali.rice.kim.bo.entity.KimEntityPhone;
 import org.kuali.rice.kim.bo.entity.KimPrincipal;
 import org.kuali.rice.kim.bo.entity.dto.KimEntityDefaultInfo;
 import org.kuali.rice.kim.bo.entity.dto.KimEntityEntityTypeDefaultInfo;
 import org.kuali.rice.kim.bo.entity.impl.KimEntityDefaultInfoCacheImpl;
 import org.kuali.rice.kim.bo.reference.impl.EmploymentStatusImpl;
 import org.kuali.rice.kim.bo.reference.impl.EmploymentTypeImpl;
 import org.kuali.rice.kim.service.IdentityManagementService;
 import org.kuali.rice.kim.service.KIMServiceLocator;
 import org.kuali.rice.kim.service.PersonService;
 import org.kuali.rice.kim.util.KimCommonUtilsInternal;
 import org.kuali.rice.kim.util.KimConstants;
 import org.kuali.rice.kns.bo.TransientBusinessObjectBase;
 //import org.kuali.rice.shareddata.api.campus.Campus;
 
 /**
  * This is a description of what this class does - jonathan don't forget to fill this in. 
  * 
  * @author Kuali Rice Team (rice.collab@kuali.org)
  *
  */
 public class PersonImpl extends TransientBusinessObjectBase implements Person {
 
         private static final long serialVersionUID = 1L;
         
         protected static PersonService personService;
         protected static IdentityManagementService identityManagementService;
 
         private String lookupRoleNamespaceCode;
         private String lookupRoleName;
         
         // principal data
         protected String principalId;
         protected String principalName;
         protected String entityId;
         protected String entityTypeCode;
         // name data
         protected String firstName = "";
         protected String middleName = "";
         protected String lastName = "";
         
         protected String name = "";
         // address data
         protected String addressLine1 = "";
         protected String addressLine2 = "";
         protected String addressLine3 = "";
         protected String addressCityName = "";
         protected String addressStateCode = "";
         protected String addressPostalCode = "";
         protected String addressCountryCode = "";
         // email data
         protected String emailAddress = "";
         // phone data
         protected String phoneNumber = "";
         // privacy preferences data
         protected boolean suppressName = false;
         protected boolean suppressAddress = false;
         protected boolean suppressPhone = false;
         protected boolean suppressPersonal = false;
         protected boolean suppressEmail = false;
         // affiliation data
         protected List<? extends KimEntityAffiliation> affiliations;
         
         protected String campusCode = "";
         //protected Campus campus;
         // external identifier data
         protected Map<String,String> externalIdentifiers = null;
         // employment data
         protected String employeeStatusCode = "";
         protected EmploymentStatusImpl employeeStatus;
         protected String employeeTypeCode = "";
         protected EmploymentTypeImpl employeeType;
         protected String primaryDepartmentCode = "";
         protected String employeeId = "";
         
         protected KualiDecimal baseSalaryAmount = KualiDecimal.ZERO;
         protected boolean active = true;
         
         public PersonImpl() {}
         
         public PersonImpl( KimPrincipal principal, String personEntityTypeCode ) {
                 this( principal, null, personEntityTypeCode );
         }
 
         public PersonImpl( KimPrincipal principal, KimEntityDefaultInfo entity, String personEntityTypeCode ) {
                 setPrincipal( principal, entity, personEntityTypeCode );
         }
         
         public PersonImpl( String principalId, String personEntityTypeCode ) {
                 this( getIdentityManagementService().getPrincipal(principalId), personEntityTypeCode );
         }
         
         public PersonImpl( KimEntityDefaultInfoCacheImpl p ) {
                 entityId = p.getEntityId();
                 principalId = p.getPrincipalId();
                 principalName = p.getPrincipalName();
                 entityTypeCode = p.getEntityTypeCode();
                 firstName = p.getFirstName();
                 middleName = p.getMiddleName();
                 lastName = p.getLastName();
                 name = p.getName();
                 campusCode = p.getCampusCode();
                 primaryDepartmentCode = p.getPrimaryDepartmentCode();
                 employeeId = p.getEmployeeId();
                 affiliations = new ArrayList<KimEntityAffiliation>( 0 );
                 externalIdentifiers = new HashMap<String,String>( 0 );
         }
 
         /**
          * Sets the principal object and populates the person object from that. 
          */
         public void setPrincipal(KimPrincipal principal, KimEntityDefaultInfo entity, String personEntityTypeCode) {
                 populatePrincipalInfo( principal );
                 if ( entity == null ) {
                         entity = getIdentityManagementService().getEntityDefaultInfo( principal.getEntityId() );
                 }
                 populateEntityInfo( entity, principal, personEntityTypeCode );
         }
 
         
         protected void populatePrincipalInfo( KimPrincipal principal ) {
                 entityId = principal.getEntityId();
                 principalId = principal.getPrincipalId();
                 principalName = principal.getPrincipalName();
                 active = principal.isActive();
         }
         
         protected void populateEntityInfo( KimEntityDefaultInfo entity, KimPrincipal principal, String personEntityTypeCode ) {
                 if(entity!=null){
                     populatePrivacyInfo (entity );
                         KimEntityEntityTypeDefaultInfo entityEntityType = entity.getEntityType( personEntityTypeCode );  
                         entityTypeCode = personEntityTypeCode;
                         populateNameInfo( personEntityTypeCode, entity, principal );
                         populateAddressInfo( entityEntityType );
                         populateEmailInfo( entityEntityType );
                         populatePhoneInfo( entityEntityType );
                         populateAffiliationInfo( entity );
                         populateEmploymentInfo( entity );
                         populateExternalIdentifiers( entity );
                 }
         }
         
         protected void populateNameInfo( String entityTypeCode, KimEntityDefaultInfo entity, KimPrincipal principal ) {
                 if(entity!=null){
                         KimEntityName entityName = entity.getDefaultName();
                         if ( entityName != null ) {
                                 firstName = unNullify( entityName.getFirstName());
                                 middleName = unNullify( entityName.getMiddleName() );
                                 lastName = unNullify( entityName.getLastName() );
                                 if ( entityTypeCode.equals( KimConstants.EntityTypes.SYSTEM ) ) {
                                         name = principal.getPrincipalName().toUpperCase();
                                 } else {
                                         name = unNullify( entityName.getFormattedName() );
                                         if(name.equals("") || name == null){
                                                 name = lastName + ", " + firstName;                                        
                                         }
                                 }
                         } else {
                                 firstName = "";
                                 middleName = "";
                                 if ( entityTypeCode.equals( KimConstants.EntityTypes.SYSTEM ) ) {
                                         name = principal.getPrincipalName().toUpperCase();
                                         lastName = principal.getPrincipalName().toUpperCase();
                                 } else {
                                         name = "";
                                         lastName = "";
                                 }
                         }
                 }
         }
         
         protected void populatePrivacyInfo (KimEntityDefaultInfo entity) {
             if(entity!=null) {
                 if (entity.getPrivacyPreferences() != null) {
                     suppressName = entity.getPrivacyPreferences().isSuppressName();
                     suppressAddress = entity.getPrivacyPreferences().isSuppressAddress();
                     suppressPhone = entity.getPrivacyPreferences().isSuppressPhone();
                     suppressPersonal = entity.getPrivacyPreferences().isSuppressPersonal();
                     suppressEmail = entity.getPrivacyPreferences().isSuppressEmail();
                 }
             }
         }
         
         protected void populateAddressInfo( KimEntityEntityTypeDefaultInfo entityEntityType ) {
                 if(entityEntityType!=null){
                         KimEntityAddress defaultAddress = entityEntityType.getDefaultAddress();
                         if ( defaultAddress != null ) {                        
                                 addressLine1 = unNullify( defaultAddress.getLine1Unmasked() );
                                 addressLine2 = unNullify( defaultAddress.getLine2Unmasked() );
                                 addressLine3 = unNullify( defaultAddress.getLine3Unmasked() );
                                 addressCityName = unNullify( defaultAddress.getCityNameUnmasked() );
                                 addressStateCode = unNullify( defaultAddress.getStateCodeUnmasked() );
                                 addressPostalCode = unNullify( defaultAddress.getPostalCodeUnmasked() );
                                 addressCountryCode = unNullify( defaultAddress.getCountryCodeUnmasked() );
                         } else {
                                 addressLine1 = "";
                                 addressLine2 = "";
                                 addressLine3 = "";
                                 addressCityName = "";
                                 addressStateCode = "";
                                 addressPostalCode = "";
                                 addressCountryCode = "";
                         }
                 }
         }
         
         protected void populateEmailInfo( KimEntityEntityTypeDefaultInfo entityEntityType ) {
                 if(entityEntityType!=null){
                         KimEntityEmail entityEmail = entityEntityType.getDefaultEmailAddress();
                         if ( entityEmail != null ) {
                                 emailAddress = unNullify( entityEmail.getEmailAddressUnmasked() );
                         } else {
                                 emailAddress = "";
                         }
                 }
         }
         
         protected void populatePhoneInfo( KimEntityEntityTypeDefaultInfo entityEntityType ) {
                 if(entityEntityType!=null){
                         KimEntityPhone entityPhone = entityEntityType.getDefaultPhoneNumber();
                         if ( entityPhone != null ) {
                                 phoneNumber = unNullify( entityPhone.getFormattedPhoneNumberUnmasked() );
                         } else {
                                 phoneNumber = "";
                         }
                 }
         }
         
         protected void populateAffiliationInfo( KimEntityDefaultInfo entity ) {
                 if(entity!=null){
                         affiliations = entity.getAffiliations();
                         KimEntityAffiliation defaultAffiliation = entity.getDefaultAffiliation();
                         if ( defaultAffiliation != null  ) {
                                 campusCode = unNullify( defaultAffiliation.getCampusCode() );
                         } else {
                                 campusCode = "";
                         }
                 }
         }
         
         protected void populateEmploymentInfo( KimEntityDefaultInfo entity ) {
                 if(entity!=null){
                         KimEntityEmploymentInformation employmentInformation = entity.getPrimaryEmployment();
                         if ( employmentInformation != null ) {
                                 employeeStatusCode = unNullify( employmentInformation.getEmployeeStatusCode() );
                                 employeeTypeCode = unNullify( employmentInformation.getEmployeeTypeCode() );
                                 primaryDepartmentCode = unNullify( employmentInformation.getPrimaryDepartmentCode() );
                                 employeeId = unNullify( employmentInformation.getEmployeeId() );
                                 if ( employmentInformation.getBaseSalaryAmount() != null ) {
                                         baseSalaryAmount = employmentInformation.getBaseSalaryAmount();
                                 } else {
                                         baseSalaryAmount = KualiDecimal.ZERO;
                                 }
                         } else {
                                 employeeStatusCode = "";
                                 employeeTypeCode = "";
                                 primaryDepartmentCode = "";
                                 employeeId = "";
                                 baseSalaryAmount = KualiDecimal.ZERO;
                         }
                 }
         }
         
         protected void populateExternalIdentifiers( KimEntityDefaultInfo entity ) {
                 if(entity!=null){
                         List<? extends KimEntityExternalIdentifier> externalIds = entity.getExternalIdentifiers();
                         externalIdentifiers = new HashMap<String,String>( externalIds.size() );
                         for ( KimEntityExternalIdentifier eei : externalIds ) {
                                 externalIdentifiers.put( eei.getExternalIdentifierTypeCode(), eei.getExternalId() );
                         }
                 }
         }
         
         /** So users of this class don't need to program around nulls. */
         private String unNullify( String str ) {
                 if ( str == null ) {
                         return "";
                 }
                 return str;
         }
         
         /**
          * @see org.kuali.rice.kim.bo.Person#getEntityId()
          */
         public String getEntityId() {
                 return entityId;
         }
         
         /**
          * @see org.kuali.rice.kim.bo.Person#getPrincipalId()
          */
         public String getPrincipalId() {
                 return principalId;
         }
         
         /**
          * This overridden method ...
          * 
          * @see org.kuali.rice.kim.bo.Person#getPrincipalName()
          */
         public String getPrincipalName() {
                 return principalName;
         }
         
         /**
          * @see org.kuali.rice.kim.bo.Person#getFirstName()
          */
         public String getFirstName() {
             if (KimCommonUtilsInternal.isSuppressName(getEntityId())){
                 return KimConstants.RESTRICTED_DATA_MASK;
             }
                 return firstName;
         }
         
         /**
      * @see org.kuali.rice.kim.bo.Person#getFirstNameUnmasked()
      */
     public String getFirstNameUnmasked() {
         return firstName;
     }
 
         /**
          * @see org.kuali.rice.kim.bo.Person#getMiddleName()
          */
         public String getMiddleName() {
             if (KimCommonUtilsInternal.isSuppressName(getEntityId())){
             return KimConstants.RESTRICTED_DATA_MASK;
         }
                 return middleName;
         }
         
         /**
      * @see org.kuali.rice.kim.bo.Person#getMiddleNameUnmasked()
      */
         public String getMiddleNameUnmasked() {
             return middleName;
         }
         
         /**
          * @see org.kuali.rice.kim.bo.Person#getLastName()
          */
         public String getLastName() {
             if (KimCommonUtilsInternal.isSuppressName(getEntityId())){
             return KimConstants.RESTRICTED_DATA_MASK;
         }
                 return lastName;
         }
         
         /**
      * @see org.kuali.rice.kim.bo.Person#getLastNameUnmasked()
      */
     public String getLastNameUnmasked() {
         return lastName;
     }
         
         /**
          * @see org.kuali.rice.kim.bo.Person#getName()
          */
         public String getName() {
             if (KimCommonUtilsInternal.isSuppressName(getEntityId())){
             return KimConstants.RESTRICTED_DATA_MASK;
         }
             return name;
         }
         
         public String getNameUnmasked() {
             return this.name;
         }
         
         /**
          * @see org.kuali.rice.kim.bo.Person#getPhoneNumber()
          */
         public String getPhoneNumber() {
             if (KimCommonUtilsInternal.isSuppressPhone(getEntityId())){
             return KimConstants.RESTRICTED_DATA_MASK;
         }
                 return phoneNumber;
         }
         
            /**
      * @see org.kuali.rice.kim.bo.Person#getPhoneNumberUnmasked()
      */
     public String getPhoneNumberUnmasked() {
         return phoneNumber;
     }
 
         /**
          * @see org.kuali.rice.kim.bo.Person#getEmailAddress()
          */
         public String getEmailAddress() {
             if (KimCommonUtilsInternal.isSuppressEmail(getEntityId())){
             return KimConstants.RESTRICTED_DATA_MASK;
         }
                 return emailAddress;
         }
         
         public String getEmailAddressUnmasked() {
             return emailAddress;
         }
         
         public List<? extends KimEntityAffiliation> getAffiliations() {
                 return affiliations;
         }
         
         /**
          * This overridden method ...
          * 
          * @see org.kuali.rice.kim.bo.Person#hasAffiliationOfType(java.lang.String)
          */
         public boolean hasAffiliationOfType(String affiliationTypeCode) {
                 return getCampusCodesForAffiliationOfType(affiliationTypeCode).size() > 0;
         }
         
         
         public List<String> getCampusCodesForAffiliationOfType(String affiliationTypeCode) {
                 ArrayList<String> campusCodes = new ArrayList<String>( 3 );
                 if ( affiliationTypeCode == null ) {
                         return campusCodes;
                 }
                 for ( KimEntityAffiliation a : getAffiliations() ) {
                         if ( a.getAffiliationTypeCode().equals(affiliationTypeCode)  ) {
                                 campusCodes.add( a.getCampusCode() );
                         }
                 }
                 return campusCodes;
         }
         
         /**
          * @see org.kuali.rice.kim.bo.Person#getExternalId(java.lang.String)
          */
         public String getExternalId(String externalIdentifierTypeCode) {
                 return externalIdentifiers.get( externalIdentifierTypeCode );
         }
         
         /**
          * Pulls the campus code from the default affiliation for the entity.
          * Returns null if no default affiliation is set.
          * @see org.kuali.rice.kim.bo.Person#getCampusCode()
          */
         public String getCampusCode() {
                 return campusCode;
         }
 
         /**
          * @return the personService
          */
         @SuppressWarnings("unchecked")
         public static PersonService getPersonService() {
                 if ( personService == null ) {
                         personService = KIMServiceLocator.getPersonService();
                 }
                 return personService;
         }
 
         /**
          * @return the identityManagementService
          */
         public static IdentityManagementService getIdentityManagementService() {
                 if ( identityManagementService == null ) {
                         identityManagementService = KIMServiceLocator.getIdentityManagementService();
                 }
                 return identityManagementService;
         }
 
         /**
          * @see org.kuali.rice.kim.bo.Person#getExternalIdentifiers()
          */
         public Map<String,String> getExternalIdentifiers() {
                 return externalIdentifiers;
         }
 
         public String getAddressLine1() {
             if (KimCommonUtilsInternal.isSuppressAddress(getEntityId())){
             return KimConstants.RESTRICTED_DATA_MASK;
         }
                 return this.addressLine1;
         }
         
         public String getAddressLine1Unmasked() {
             return this.addressLine1;
         }
 
         public String getAddressLine2() {
             if (KimCommonUtilsInternal.isSuppressAddress(getEntityId())){
             return KimConstants.RESTRICTED_DATA_MASK;
         }
                 return this.addressLine2;
         }
         
         public String getAddressLine2Unmasked() {
         return this.addressLine2;
     }
 
         public String getAddressLine3() {
             if (KimCommonUtilsInternal.isSuppressAddress(getEntityId())){
             return KimConstants.RESTRICTED_DATA_MASK;
         }
                 return this.addressLine3;
         }
         
         public String getAddressLine3Unmasked() {
         return this.addressLine3;
     }
 
         public String getAddressCityName() {
             if (KimCommonUtilsInternal.isSuppressAddress(getEntityId())){
             return KimConstants.RESTRICTED_DATA_MASK;
         }
                 return this.addressCityName;
         }
         
         public String getAddressCityNameUnmasked() {
         return this.addressCityName;
     }
 
         public String getAddressStateCode() {
             if (KimCommonUtilsInternal.isSuppressAddress(getEntityId())){
             return KimConstants.RESTRICTED_DATA_MASK;
         }
                 return this.addressStateCode;
         }
         
         public String getAddressStateCodeUnmasked() {
         return this.addressStateCode;
     }
 
         public String getAddressPostalCode() {
             if (KimCommonUtilsInternal.isSuppressAddress(getEntityId())){
             return KimConstants.RESTRICTED_DATA_MASK;
         }
                 return this.addressPostalCode;
         }
         
         public String getAddressPostalCodeUnmasked() {
         return this.addressPostalCode;
     }
 
         public String getAddressCountryCode() {
             if (KimCommonUtilsInternal.isSuppressAddress(getEntityId())){
             return KimConstants.RESTRICTED_DATA_MASK;
         }
                 return this.addressCountryCode;
         }
         
         public String getAddressCountryCodeUnmasked() {
         return this.addressCountryCode;
     }
 
         public String getEmployeeStatusCode() {
                 return this.employeeStatusCode;
         }
 
         public String getEmployeeTypeCode() {
                 return this.employeeTypeCode;
         }
 
         public KualiDecimal getBaseSalaryAmount() {
                 return this.baseSalaryAmount;
         }
 
         public String getEmployeeId() {
                 return this.employeeId;
         }
 
         public String getPrimaryDepartmentCode() {
                 return this.primaryDepartmentCode;
         }
 
         public String getEntityTypeCode() {
                 return this.entityTypeCode;
         }
 
         public boolean isActive() {
                 return this.active;
         }
 
         public void setActive(boolean active) {
                 this.active = active;
         }
 
         /**
          * @return the lookupRoleNamespaceCode
          */
         public String getLookupRoleNamespaceCode() {
                 return this.lookupRoleNamespaceCode;
         }
 
         /**
          * @param lookupRoleNamespaceCode the lookupRoleNamespaceCode to set
          */
         public void setLookupRoleNamespaceCode(String lookupRoleNamespaceCode) {
                 this.lookupRoleNamespaceCode = lookupRoleNamespaceCode;
         }
 
         /**
          * @return the lookupRoleName
          */
         public String getLookupRoleName() {
                 return this.lookupRoleName;
         }
 
         /**
          * @param lookupRoleName the lookupRoleName to set
          */
         public void setLookupRoleName(String lookupRoleName) {
                 this.lookupRoleName = lookupRoleName;
         }
 
         /**
          * @param principalName the principalName to set
          */
         public void setPrincipalName(String principalName) {
                 this.principalName = principalName;
         }
 
         /**
          * @param name the name to set
          */
         public void setName(String name) {
                 this.name = name;
         }
 
         //public Campus getCampus() {
         //        return this.campus;
         //}
 
         public EmploymentStatusImpl getEmployeeStatus() {
                 return this.employeeStatus;
         }
 
         public EmploymentTypeImpl getEmployeeType() {
                 return this.employeeType;
         }
 }

1		/*
2		* Copyright 2007-2008 The Kuali Foundation
3		*
4		* Licensed under the Educational Community License, Version 2.0 (the "License");
5		* you may not use this file except in compliance with the License.
6		* You may obtain a copy of the License at
7		*
8		* http://www.opensource.org/licenses/ecl2.php
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13		* See the License for the specific language governing permissions and
14		* limitations under the License.
15		*/
16		package org.kuali.rice.kim.bo.impl;
17
18		import java.util.ArrayList;
19		import java.util.HashMap;
20		import java.util.List;
21		import java.util.Map;
22
23		import org.kuali.rice.core.util.type.KualiDecimal;
24		import org.kuali.rice.kim.bo.Person;
25		import org.kuali.rice.kim.bo.entity.KimEntityAddress;
26		import org.kuali.rice.kim.bo.entity.KimEntityAffiliation;
27		import org.kuali.rice.kim.bo.entity.KimEntityEmail;
28		import org.kuali.rice.kim.bo.entity.KimEntityEmploymentInformation;
29		import org.kuali.rice.kim.bo.entity.KimEntityExternalIdentifier;
30		import org.kuali.rice.kim.bo.entity.KimEntityName;
31		import org.kuali.rice.kim.bo.entity.KimEntityPhone;
32		import org.kuali.rice.kim.bo.entity.KimPrincipal;
33		import org.kuali.rice.kim.bo.entity.dto.KimEntityDefaultInfo;
34		import org.kuali.rice.kim.bo.entity.dto.KimEntityEntityTypeDefaultInfo;
35		import org.kuali.rice.kim.bo.entity.impl.KimEntityDefaultInfoCacheImpl;
36		import org.kuali.rice.kim.bo.reference.impl.EmploymentStatusImpl;
37		import org.kuali.rice.kim.bo.reference.impl.EmploymentTypeImpl;
38		import org.kuali.rice.kim.service.IdentityManagementService;
39		import org.kuali.rice.kim.service.KIMServiceLocator;
40		import org.kuali.rice.kim.service.PersonService;
41		import org.kuali.rice.kim.util.KimCommonUtilsInternal;
42		import org.kuali.rice.kim.util.KimConstants;
43		import org.kuali.rice.kns.bo.TransientBusinessObjectBase;
44		//import org.kuali.rice.shareddata.api.campus.Campus;
45
46		/**
47		* This is a description of what this class does - jonathan don't forget to fill this in.
48		*
49		* @author Kuali Rice Team (rice.collab@kuali.org)
50		*
51		*/
52		public class PersonImpl extends TransientBusinessObjectBase implements Person {
53
54		private static final long serialVersionUID = 1L;
55
56		protected static PersonService personService;
57		protected static IdentityManagementService identityManagementService;
58
59		private String lookupRoleNamespaceCode;
60		private String lookupRoleName;
61
62		// principal data
63		protected String principalId;
64		protected String principalName;
65		protected String entityId;
66		protected String entityTypeCode;
67		// name data
68	0	protected String firstName = "";
69	0	protected String middleName = "";
70	0	protected String lastName = "";
71
72	0	protected String name = "";
73		// address data
74	0	protected String addressLine1 = "";
75	0	protected String addressLine2 = "";
76	0	protected String addressLine3 = "";
77	0	protected String addressCityName = "";
78	0	protected String addressStateCode = "";
79	0	protected String addressPostalCode = "";
80	0	protected String addressCountryCode = "";
81		// email data
82	0	protected String emailAddress = "";
83		// phone data
84	0	protected String phoneNumber = "";
85		// privacy preferences data
86	0	protected boolean suppressName = false;
87	0	protected boolean suppressAddress = false;
88	0	protected boolean suppressPhone = false;
89	0	protected boolean suppressPersonal = false;
90	0	protected boolean suppressEmail = false;
91		// affiliation data
92		protected List<? extends KimEntityAffiliation> affiliations;
93
94	0	protected String campusCode = "";
95		//protected Campus campus;
96		// external identifier data
97	0	protected Map<String,String> externalIdentifiers = null;
98		// employment data
99	0	protected String employeeStatusCode = "";
100		protected EmploymentStatusImpl employeeStatus;
101	0	protected String employeeTypeCode = "";
102		protected EmploymentTypeImpl employeeType;
103	0	protected String primaryDepartmentCode = "";
104	0	protected String employeeId = "";
105
106	0	protected KualiDecimal baseSalaryAmount = KualiDecimal.ZERO;
107	0	protected boolean active = true;
108
109	0	public PersonImpl() {}
110
111		public PersonImpl( KimPrincipal principal, String personEntityTypeCode ) {
112	0	this( principal, null, personEntityTypeCode );
113	0	}
114
115	0	public PersonImpl( KimPrincipal principal, KimEntityDefaultInfo entity, String personEntityTypeCode ) {
116	0	setPrincipal( principal, entity, personEntityTypeCode );
117	0	}
118
119		public PersonImpl( String principalId, String personEntityTypeCode ) {
120	0	this( getIdentityManagementService().getPrincipal(principalId), personEntityTypeCode );
121	0	}
122
123	0	public PersonImpl( KimEntityDefaultInfoCacheImpl p ) {
124	0	entityId = p.getEntityId();
125	0	principalId = p.getPrincipalId();
126	0	principalName = p.getPrincipalName();
127	0	entityTypeCode = p.getEntityTypeCode();
128	0	firstName = p.getFirstName();
129	0	middleName = p.getMiddleName();
130	0	lastName = p.getLastName();
131	0	name = p.getName();
132	0	campusCode = p.getCampusCode();
133	0	primaryDepartmentCode = p.getPrimaryDepartmentCode();
134	0	employeeId = p.getEmployeeId();
135	0	affiliations = new ArrayList<KimEntityAffiliation>( 0 );
136	0	externalIdentifiers = new HashMap<String,String>( 0 );
137	0	}
138
139		/**
140		* Sets the principal object and populates the person object from that.
141		*/
142		public void setPrincipal(KimPrincipal principal, KimEntityDefaultInfo entity, String personEntityTypeCode) {
143	0	populatePrincipalInfo( principal );
144	0	if ( entity == null ) {
145	0	entity = getIdentityManagementService().getEntityDefaultInfo( principal.getEntityId() );
146		}
147	0	populateEntityInfo( entity, principal, personEntityTypeCode );
148	0	}
149
150
151		protected void populatePrincipalInfo( KimPrincipal principal ) {
152	0	entityId = principal.getEntityId();
153	0	principalId = principal.getPrincipalId();
154	0	principalName = principal.getPrincipalName();
155	0	active = principal.isActive();
156	0	}
157
158		protected void populateEntityInfo( KimEntityDefaultInfo entity, KimPrincipal principal, String personEntityTypeCode ) {
159	0	if(entity!=null){
160	0	populatePrivacyInfo (entity );
161	0	KimEntityEntityTypeDefaultInfo entityEntityType = entity.getEntityType( personEntityTypeCode );
162	0	entityTypeCode = personEntityTypeCode;
163	0	populateNameInfo( personEntityTypeCode, entity, principal );
164	0	populateAddressInfo( entityEntityType );
165	0	populateEmailInfo( entityEntityType );
166	0	populatePhoneInfo( entityEntityType );
167	0	populateAffiliationInfo( entity );
168	0	populateEmploymentInfo( entity );
169	0	populateExternalIdentifiers( entity );
170		}
171	0	}
172
173		protected void populateNameInfo( String entityTypeCode, KimEntityDefaultInfo entity, KimPrincipal principal ) {
174	0	if(entity!=null){
175	0	KimEntityName entityName = entity.getDefaultName();
176	0	if ( entityName != null ) {
177	0	firstName = unNullify( entityName.getFirstName());
178	0	middleName = unNullify( entityName.getMiddleName() );
179	0	lastName = unNullify( entityName.getLastName() );
180	0	if ( entityTypeCode.equals( KimConstants.EntityTypes.SYSTEM ) ) {
181	0	name = principal.getPrincipalName().toUpperCase();
182		} else {
183	0	name = unNullify( entityName.getFormattedName() );
184	0	if(name.equals("") \|\| name == null){
185	0	name = lastName + ", " + firstName;
186		}
187		}
188		} else {
189	0	firstName = "";
190	0	middleName = "";
191	0	if ( entityTypeCode.equals( KimConstants.EntityTypes.SYSTEM ) ) {
192	0	name = principal.getPrincipalName().toUpperCase();
193	0	lastName = principal.getPrincipalName().toUpperCase();
194		} else {
195	0	name = "";
196	0	lastName = "";
197		}
198		}
199		}
200	0	}
201
202		protected void populatePrivacyInfo (KimEntityDefaultInfo entity) {
203	0	if(entity!=null) {
204	0	if (entity.getPrivacyPreferences() != null) {
205	0	suppressName = entity.getPrivacyPreferences().isSuppressName();
206	0	suppressAddress = entity.getPrivacyPreferences().isSuppressAddress();
207	0	suppressPhone = entity.getPrivacyPreferences().isSuppressPhone();
208	0	suppressPersonal = entity.getPrivacyPreferences().isSuppressPersonal();
209	0	suppressEmail = entity.getPrivacyPreferences().isSuppressEmail();
210		}
211		}
212	0	}
213
214		protected void populateAddressInfo( KimEntityEntityTypeDefaultInfo entityEntityType ) {
215	0	if(entityEntityType!=null){
216	0	KimEntityAddress defaultAddress = entityEntityType.getDefaultAddress();
217	0	if ( defaultAddress != null ) {
218	0	addressLine1 = unNullify( defaultAddress.getLine1Unmasked() );
219	0	addressLine2 = unNullify( defaultAddress.getLine2Unmasked() );
220	0	addressLine3 = unNullify( defaultAddress.getLine3Unmasked() );
221	0	addressCityName = unNullify( defaultAddress.getCityNameUnmasked() );
222	0	addressStateCode = unNullify( defaultAddress.getStateCodeUnmasked() );
223	0	addressPostalCode = unNullify( defaultAddress.getPostalCodeUnmasked() );
224	0	addressCountryCode = unNullify( defaultAddress.getCountryCodeUnmasked() );
225		} else {
226	0	addressLine1 = "";
227	0	addressLine2 = "";
228	0	addressLine3 = "";
229	0	addressCityName = "";
230	0	addressStateCode = "";
231	0	addressPostalCode = "";
232	0	addressCountryCode = "";
233		}
234		}
235	0	}
236
237		protected void populateEmailInfo( KimEntityEntityTypeDefaultInfo entityEntityType ) {
238	0	if(entityEntityType!=null){
239	0	KimEntityEmail entityEmail = entityEntityType.getDefaultEmailAddress();
240	0	if ( entityEmail != null ) {
241	0	emailAddress = unNullify( entityEmail.getEmailAddressUnmasked() );
242		} else {
243	0	emailAddress = "";
244		}
245		}
246	0	}
247
248		protected void populatePhoneInfo( KimEntityEntityTypeDefaultInfo entityEntityType ) {
249	0	if(entityEntityType!=null){
250	0	KimEntityPhone entityPhone = entityEntityType.getDefaultPhoneNumber();
251	0	if ( entityPhone != null ) {
252	0	phoneNumber = unNullify( entityPhone.getFormattedPhoneNumberUnmasked() );
253		} else {
254	0	phoneNumber = "";
255		}
256		}
257	0	}
258
259		protected void populateAffiliationInfo( KimEntityDefaultInfo entity ) {
260	0	if(entity!=null){
261	0	affiliations = entity.getAffiliations();
262	0	KimEntityAffiliation defaultAffiliation = entity.getDefaultAffiliation();
263	0	if ( defaultAffiliation != null ) {
264	0	campusCode = unNullify( defaultAffiliation.getCampusCode() );
265		} else {
266	0	campusCode = "";
267		}
268		}
269	0	}
270
271		protected void populateEmploymentInfo( KimEntityDefaultInfo entity ) {
272	0	if(entity!=null){
273	0	KimEntityEmploymentInformation employmentInformation = entity.getPrimaryEmployment();
274	0	if ( employmentInformation != null ) {
275	0	employeeStatusCode = unNullify( employmentInformation.getEmployeeStatusCode() );
276	0	employeeTypeCode = unNullify( employmentInformation.getEmployeeTypeCode() );
277	0	primaryDepartmentCode = unNullify( employmentInformation.getPrimaryDepartmentCode() );
278	0	employeeId = unNullify( employmentInformation.getEmployeeId() );
279	0	if ( employmentInformation.getBaseSalaryAmount() != null ) {
280	0	baseSalaryAmount = employmentInformation.getBaseSalaryAmount();
281		} else {
282	0	baseSalaryAmount = KualiDecimal.ZERO;
283		}
284		} else {
285	0	employeeStatusCode = "";
286	0	employeeTypeCode = "";
287	0	primaryDepartmentCode = "";
288	0	employeeId = "";
289	0	baseSalaryAmount = KualiDecimal.ZERO;
290		}
291		}
292	0	}
293
294		protected void populateExternalIdentifiers( KimEntityDefaultInfo entity ) {
295	0	if(entity!=null){
296	0	List<? extends KimEntityExternalIdentifier> externalIds = entity.getExternalIdentifiers();
297	0	externalIdentifiers = new HashMap<String,String>( externalIds.size() );
298	0	for ( KimEntityExternalIdentifier eei : externalIds ) {
299	0	externalIdentifiers.put( eei.getExternalIdentifierTypeCode(), eei.getExternalId() );
300		}
301		}
302	0	}
303
304		/** So users of this class don't need to program around nulls. */
305		private String unNullify( String str ) {
306	0	if ( str == null ) {
307	0	return "";
308		}
309	0	return str;
310		}
311
312		/**
313		* @see org.kuali.rice.kim.bo.Person#getEntityId()
314		*/
315		public String getEntityId() {
316	0	return entityId;
317		}
318
319		/**
320		* @see org.kuali.rice.kim.bo.Person#getPrincipalId()
321		*/
322		public String getPrincipalId() {
323	0	return principalId;
324		}
325
326		/**
327		* This overridden method ...
328		*
329		* @see org.kuali.rice.kim.bo.Person#getPrincipalName()
330		*/
331		public String getPrincipalName() {
332	0	return principalName;
333		}
334
335		/**
336		* @see org.kuali.rice.kim.bo.Person#getFirstName()
337		*/
338		public String getFirstName() {
339	0	if (KimCommonUtilsInternal.isSuppressName(getEntityId())){
340	0	return KimConstants.RESTRICTED_DATA_MASK;
341		}
342	0	return firstName;
343		}
344
345		/**
346		* @see org.kuali.rice.kim.bo.Person#getFirstNameUnmasked()
347		*/
348		public String getFirstNameUnmasked() {
349	0	return firstName;
350		}
351
352		/**
353		* @see org.kuali.rice.kim.bo.Person#getMiddleName()
354		*/
355		public String getMiddleName() {
356	0	if (KimCommonUtilsInternal.isSuppressName(getEntityId())){
357	0	return KimConstants.RESTRICTED_DATA_MASK;
358		}
359	0	return middleName;
360		}
361
362		/**
363		* @see org.kuali.rice.kim.bo.Person#getMiddleNameUnmasked()
364		*/
365		public String getMiddleNameUnmasked() {
366	0	return middleName;
367		}
368
369		/**
370		* @see org.kuali.rice.kim.bo.Person#getLastName()
371		*/
372		public String getLastName() {
373	0	if (KimCommonUtilsInternal.isSuppressName(getEntityId())){
374	0	return KimConstants.RESTRICTED_DATA_MASK;
375		}
376	0	return lastName;
377		}
378
379		/**
380		* @see org.kuali.rice.kim.bo.Person#getLastNameUnmasked()
381		*/
382		public String getLastNameUnmasked() {
383	0	return lastName;
384		}
385
386		/**
387		* @see org.kuali.rice.kim.bo.Person#getName()
388		*/
389		public String getName() {
390	0	if (KimCommonUtilsInternal.isSuppressName(getEntityId())){
391	0	return KimConstants.RESTRICTED_DATA_MASK;
392		}
393	0	return name;
394		}
395
396		public String getNameUnmasked() {
397	0	return this.name;
398		}
399
400		/**
401		* @see org.kuali.rice.kim.bo.Person#getPhoneNumber()
402		*/
403		public String getPhoneNumber() {
404	0	if (KimCommonUtilsInternal.isSuppressPhone(getEntityId())){
405	0	return KimConstants.RESTRICTED_DATA_MASK;
406		}
407	0	return phoneNumber;
408		}
409
410		/**
411		* @see org.kuali.rice.kim.bo.Person#getPhoneNumberUnmasked()
412		*/
413		public String getPhoneNumberUnmasked() {
414	0	return phoneNumber;
415		}
416
417		/**
418		* @see org.kuali.rice.kim.bo.Person#getEmailAddress()
419		*/
420		public String getEmailAddress() {
421	0	if (KimCommonUtilsInternal.isSuppressEmail(getEntityId())){
422	0	return KimConstants.RESTRICTED_DATA_MASK;
423		}
424	0	return emailAddress;
425		}
426
427		public String getEmailAddressUnmasked() {
428	0	return emailAddress;
429		}
430
431		public List<? extends KimEntityAffiliation> getAffiliations() {
432	0	return affiliations;
433		}
434
435		/**
436		* This overridden method ...
437		*
438		* @see org.kuali.rice.kim.bo.Person#hasAffiliationOfType(java.lang.String)
439		*/
440		public boolean hasAffiliationOfType(String affiliationTypeCode) {
441	0	return getCampusCodesForAffiliationOfType(affiliationTypeCode).size() > 0;
442		}
443
444
445		public List<String> getCampusCodesForAffiliationOfType(String affiliationTypeCode) {
446	0	ArrayList<String> campusCodes = new ArrayList<String>( 3 );
447	0	if ( affiliationTypeCode == null ) {
448	0	return campusCodes;
449		}
450	0	for ( KimEntityAffiliation a : getAffiliations() ) {
451	0	if ( a.getAffiliationTypeCode().equals(affiliationTypeCode) ) {
452	0	campusCodes.add( a.getCampusCode() );
453		}
454		}
455	0	return campusCodes;
456		}
457
458		/**
459		* @see org.kuali.rice.kim.bo.Person#getExternalId(java.lang.String)
460		*/
461		public String getExternalId(String externalIdentifierTypeCode) {
462	0	return externalIdentifiers.get( externalIdentifierTypeCode );
463		}
464
465		/**
466		* Pulls the campus code from the default affiliation for the entity.
467		* Returns null if no default affiliation is set.
468		* @see org.kuali.rice.kim.bo.Person#getCampusCode()
469		*/
470		public String getCampusCode() {
471	0	return campusCode;
472		}
473
474		/**
475		* @return the personService
476		*/
477		@SuppressWarnings("unchecked")
478		public static PersonService getPersonService() {
479	0	if ( personService == null ) {
480	0	personService = KIMServiceLocator.getPersonService();
481		}
482	0	return personService;
483		}
484
485		/**
486		* @return the identityManagementService
487		*/
488		public static IdentityManagementService getIdentityManagementService() {
489	0	if ( identityManagementService == null ) {
490	0	identityManagementService = KIMServiceLocator.getIdentityManagementService();
491		}
492	0	return identityManagementService;
493		}
494
495		/**
496		* @see org.kuali.rice.kim.bo.Person#getExternalIdentifiers()
497		*/
498		public Map<String,String> getExternalIdentifiers() {
499	0	return externalIdentifiers;
500		}
501
502		public String getAddressLine1() {
503	0	if (KimCommonUtilsInternal.isSuppressAddress(getEntityId())){
504	0	return KimConstants.RESTRICTED_DATA_MASK;
505		}
506	0	return this.addressLine1;
507		}
508
509		public String getAddressLine1Unmasked() {
510	0	return this.addressLine1;
511		}
512
513		public String getAddressLine2() {
514	0	if (KimCommonUtilsInternal.isSuppressAddress(getEntityId())){
515	0	return KimConstants.RESTRICTED_DATA_MASK;
516		}
517	0	return this.addressLine2;
518		}
519
520		public String getAddressLine2Unmasked() {
521	0	return this.addressLine2;
522		}
523
524		public String getAddressLine3() {
525	0	if (KimCommonUtilsInternal.isSuppressAddress(getEntityId())){
526	0	return KimConstants.RESTRICTED_DATA_MASK;
527		}
528	0	return this.addressLine3;
529		}
530
531		public String getAddressLine3Unmasked() {
532	0	return this.addressLine3;
533		}
534
535		public String getAddressCityName() {
536	0	if (KimCommonUtilsInternal.isSuppressAddress(getEntityId())){
537	0	return KimConstants.RESTRICTED_DATA_MASK;
538		}
539	0	return this.addressCityName;
540		}
541
542		public String getAddressCityNameUnmasked() {
543	0	return this.addressCityName;
544		}
545
546		public String getAddressStateCode() {
547	0	if (KimCommonUtilsInternal.isSuppressAddress(getEntityId())){
548	0	return KimConstants.RESTRICTED_DATA_MASK;
549		}
550	0	return this.addressStateCode;
551		}
552
553		public String getAddressStateCodeUnmasked() {
554	0	return this.addressStateCode;
555		}
556
557		public String getAddressPostalCode() {
558	0	if (KimCommonUtilsInternal.isSuppressAddress(getEntityId())){
559	0	return KimConstants.RESTRICTED_DATA_MASK;
560		}
561	0	return this.addressPostalCode;
562		}
563
564		public String getAddressPostalCodeUnmasked() {
565	0	return this.addressPostalCode;
566		}
567
568		public String getAddressCountryCode() {
569	0	if (KimCommonUtilsInternal.isSuppressAddress(getEntityId())){
570	0	return KimConstants.RESTRICTED_DATA_MASK;
571		}
572	0	return this.addressCountryCode;
573		}
574
575		public String getAddressCountryCodeUnmasked() {
576	0	return this.addressCountryCode;
577		}
578
579		public String getEmployeeStatusCode() {
580	0	return this.employeeStatusCode;
581		}
582
583		public String getEmployeeTypeCode() {
584	0	return this.employeeTypeCode;
585		}
586
587		public KualiDecimal getBaseSalaryAmount() {
588	0	return this.baseSalaryAmount;
589		}
590
591		public String getEmployeeId() {
592	0	return this.employeeId;
593		}
594
595		public String getPrimaryDepartmentCode() {
596	0	return this.primaryDepartmentCode;
597		}
598
599		public String getEntityTypeCode() {
600	0	return this.entityTypeCode;
601		}
602
603		public boolean isActive() {
604	0	return this.active;
605		}
606
607		public void setActive(boolean active) {
608	0	this.active = active;
609	0	}
610
611		/**
612		* @return the lookupRoleNamespaceCode
613		*/
614		public String getLookupRoleNamespaceCode() {
615	0	return this.lookupRoleNamespaceCode;
616		}
617
618		/**
619		* @param lookupRoleNamespaceCode the lookupRoleNamespaceCode to set
620		*/
621		public void setLookupRoleNamespaceCode(String lookupRoleNamespaceCode) {
622	0	this.lookupRoleNamespaceCode = lookupRoleNamespaceCode;
623	0	}
624
625		/**
626		* @return the lookupRoleName
627		*/
628		public String getLookupRoleName() {
629	0	return this.lookupRoleName;
630		}
631
632		/**
633		* @param lookupRoleName the lookupRoleName to set
634		*/
635		public void setLookupRoleName(String lookupRoleName) {
636	0	this.lookupRoleName = lookupRoleName;
637	0	}
638
639		/**
640		* @param principalName the principalName to set
641		*/
642		public void setPrincipalName(String principalName) {
643	0	this.principalName = principalName;
644	0	}
645
646		/**
647		* @param name the name to set
648		*/
649		public void setName(String name) {
650	0	this.name = name;
651	0	}
652
653		//public Campus getCampus() {
654		// return this.campus;
655		//}
656
657		public EmploymentStatusImpl getEmployeeStatus() {
658	0	return this.employeeStatus;
659		}
660
661		public EmploymentTypeImpl getEmployeeType() {
662	0	return this.employeeType;
663		}
664		}