/**

  * Copyright 2005-2011 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.impl.identity.name

 import javax.persistence.Id

 import javax.persistence.Column

 import javax.persistence.ManyToOne

 import javax.persistence.JoinColumn

 import javax.persistence.FetchType

 import javax.persistence.Transient

 import org.hibernate.annotations.Type

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

 import org.kuali.rice.kim.api.identity.name.EntityNameContract

 import org.kuali.rice.krad.bo.PersistableBusinessObjectBase

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

 import org.kuali.rice.kim.api.services.KimApiServiceLocator

 import org.kuali.rice.kim.api.KimApiConstants

 import java.sql.Timestamp

 import org.joda.time.DateTime

 class EntityNameBo extends PersistableBusinessObjectBase implements EntityNameContract {

         @Id

         @Column(name = "ENTITY_NM_ID")

         String id;

         @Column(name = "ENTITY_ID")

         String entityId;

         @Column(name = "NM_TYP_CD")

         String nameCode;

         @Column(name = "FIRST_NM")

         String firstName;

         @Column(name = "MIDDLE_NM")

         String middleName;

         @Column(name = "LAST_NM")

         String lastName;

         @Column(name = "PREFIX_NM")

         String namePrefix;

     @Column(name = "TITLE_NM")

     String nameTitle;

         @Column(name = "SUFFIX_NM")

         String nameSuffix;

         @ManyToOne(targetEntity=EntityNameTypeBo.class, fetch = FetchType.EAGER, cascade = [])

         @JoinColumn(name = "NM_TYP_CD", insertable = false, updatable = false)

         EntityNameTypeBo nameType;

     @Type(type="yes_no")

     @Column(name="ACTV_IND")

     boolean active;

     @Type(type="yes_no")

     @Column(name="DFLT_IND")

     boolean defaultValue;

     @Column(name = "NOTE_MSG")

         String noteMessage;

     @Column(name = "NM_CHNG_DT")

     Timestamp nameChangedDate;

         @Transient

         boolean suppressName;

     /*

      * Converts a mutable EntityNameBo to an immutable EntityName representation.

      * @param bo

      * @return an immutable EntityName

      */

     static EntityName to(EntityNameBo bo) {

         if (bo == null) { return null }

         return EntityName.Builder.create(bo).build()

     }

     /**

      * Creates a EntityNameBo business object from an immutable representation of a EntityName.

      * @param an immutable EntityName

      * @return a EntityNameBo

      */

     static EntityNameBo from(EntityName immutable) {

         if (immutable == null) {return null}

         EntityNameBo bo = new EntityNameBo()

         bo.id = immutable.id

         bo.active = immutable.active

         bo.entityId = immutable.entityId

         if (immutable.nameType != null) {

             bo.nameCode = immutable.nameType.code

         }

         bo.firstName = immutable.firstNameUnmasked

         bo.lastName = immutable.lastNameUnmasked

         bo.middleName = immutable.middleNameUnmasked

         bo.namePrefix = immutable.namePrefixUnmasked

         bo.nameTitle = immutable.nameTitleUnmasked

         bo.nameSuffix = immutable.nameSuffixUnmasked

         bo.noteMessage = immutable.noteMessage

         if (immutable.nameChangedDate != null) {

             bo.nameChangedDate = new Timestamp(immutable.nameChangedDate.millis);

         }

         bo.defaultValue = immutable.defaultValue

         bo.versionNumber = immutable.versionNumber

         bo.objectId = immutable.objectId

         return bo;

     }

     @Override

     EntityNameTypeBo getNameType() {

         return this.nameType

     }

     String getFirstName() {

         if (isSuppressName()) {

             return KimApiConstants.RestrictedMasks.RESTRICTED_DATA_MASK

         }

         return this.firstName

     }

     String getMiddleName() {

         if (isSuppressName()) {

             return KimApiConstants.RestrictedMasks.RESTRICTED_DATA_MASK

         }

         return this.middleName

     }

     String getLastName() {

         if (isSuppressName()) {

             return KimApiConstants.RestrictedMasks.RESTRICTED_DATA_MASK

         }

         return this.lastName

     }

     String getNamePrefix() {

         if (isSuppressName()) {

             return KimApiConstants.RestrictedMasks.RESTRICTED_DATA_MASK

         }

         return this.namePrefix

     }

     String getNameTitle() {

         if (isSuppressName()) {

             return KimApiConstants.RestrictedMasks.RESTRICTED_DATA_MASK

         }

         return this.nameTitle

     }

     String getFirstNameUnmasked() {

         return this.firstName

     }

     String getMiddleNameUnmasked() {

         return this.middleName

     }

     String getLastNameUnmasked() {

         return this.lastName

     }

     String getNamePrefixUnmasked() {

         return this.namePrefix

     }

     String getNameTitleUnmasked() {

         return this.nameTitle

     }

     String getNameSuffixUnmasked() {

         return this.nameSuffix

     }

     String getCompositeName() {

         if (isSuppressName()) {

             return KimApiConstants.RestrictedMasks.RESTRICTED_DATA_MASK

         }

         return getCompositeNameUnmasked()

     }

     String getCompositeNameUnmasked() {

         return getLastName() + ", " + getFirstName() + (getMiddleName()==null?"":" " + getMiddleName())

     }

     DateTime getNameChangedDate() {

         return nameChangedDate ? new DateTime(nameChangedDate.time) : null

     }

     boolean isSuppressName() {

         if (this.suppressName == null) {

                 EntityPrivacyPreferences privacy = KimApiServiceLocator.getIdentityService().getEntityPrivacyPreferences(getEntityId())

                 if (privacy != null) {

                    this.suppressName = privacy.isSuppressName()

                 } else {

                    this.suppressName = false

                 }

             }

             return this.suppressName;

     }

 }