/**
    * 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.api.identity.name;
  
  import java.io.Serializable;
  import java.text.SimpleDateFormat;
  import java.util.Collection;
  import java.util.Date;
  import javax.xml.bind.annotation.XmlAccessType;
  import javax.xml.bind.annotation.XmlAccessorType;
  import javax.xml.bind.annotation.XmlAnyElement;
  import javax.xml.bind.annotation.XmlElement;
  import javax.xml.bind.annotation.XmlRootElement;
  import javax.xml.bind.annotation.XmlSchemaType;
  import javax.xml.bind.annotation.XmlType;
  import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
  
  import org.apache.commons.lang.StringUtils;
  import org.joda.time.DateTime;
  import org.kuali.rice.core.api.CoreConstants;
  import org.kuali.rice.core.api.mo.AbstractDataTransferObject;
  import org.kuali.rice.core.api.mo.ModelBuilder;
  import org.kuali.rice.kim.api.KimConstants;
  import org.kuali.rice.kim.api.identity.CodedAttribute;
  import org.kuali.rice.core.api.util.jaxb.DateTimeAdapter;
  import org.w3c.dom.Element;
  
  import javax.xml.bind.annotation.XmlAccessType;
  import javax.xml.bind.annotation.XmlAccessorType;
  import javax.xml.bind.annotation.XmlAnyElement;
  import javax.xml.bind.annotation.XmlElement;
  import javax.xml.bind.annotation.XmlRootElement;
  import javax.xml.bind.annotation.XmlType;
  import java.io.Serializable;
  import java.util.Collection;
  
  @XmlRootElement(name = EntityName.Constants.ROOT_ELEMENT_NAME)
  @XmlAccessorType(XmlAccessType.NONE)
  @XmlType(name = EntityName.Constants.TYPE_NAME, propOrder = {
      EntityName.Elements.ID,
      EntityName.Elements.ENTITY_ID,
      EntityName.Elements.NAME_TYPE,
      EntityName.Elements.NAME_PREFIX,
      EntityName.Elements.NAME_TITLE,
      EntityName.Elements.FIRST_NAME,
      EntityName.Elements.MIDDLE_NAME,
      EntityName.Elements.LAST_NAME,
      EntityName.Elements.NAME_SUFFIX,
      EntityName.Elements.COMPOSITE_NAME,
      EntityName.Elements.NAME_PREFIX_UNMASKED,
      EntityName.Elements.NAME_TITLE_UNMASKED,
      EntityName.Elements.FIRST_NAME_UNMASKED,
      EntityName.Elements.MIDDLE_NAME_UNMASKED,
      EntityName.Elements.LAST_NAME_UNMASKED,
      EntityName.Elements.NAME_SUFFIX_UNMASKED,
      EntityName.Elements.COMPOSITE_NAME_UNMASKED,
      EntityName.Elements.NOTE_MESSAGE,
      EntityName.Elements.NAME_CHANGED_DATE,
      EntityName.Elements.SUPPRESS_NAME,
      EntityName.Elements.DEFAULT_VALUE,
      EntityName.Elements.ACTIVE,
      CoreConstants.CommonElements.VERSION_NUMBER,
      CoreConstants.CommonElements.OBJECT_ID,
      CoreConstants.CommonElements.FUTURE_ELEMENTS
  })
  public final class EntityName extends AbstractDataTransferObject
      implements EntityNameContract
  {
  
      @XmlElement(name = Elements.NAME_SUFFIX, required = false)
      private final String nameSuffix;
      @XmlElement(name = Elements.ENTITY_ID, required = false)
      private final String entityId;
      @XmlElement(name = Elements.NAME_TYPE, required = false)
      private final CodedAttribute nameType;
      @XmlElement(name = Elements.FIRST_NAME, required = false)
      private final String firstName;
      @XmlElement(name = Elements.FIRST_NAME_UNMASKED, required = false)
      private final String firstNameUnmasked;
      @XmlElement(name = Elements.MIDDLE_NAME, required = false)
      private final String middleName;
      @XmlElement(name = Elements.MIDDLE_NAME_UNMASKED, required = false)
      private final String middleNameUnmasked;
      @XmlElement(name = Elements.LAST_NAME, required = false)
      private final String lastName;
      @XmlElement(name = Elements.LAST_NAME_UNMASKED, required = false)
     private final String lastNameUnmasked;
     @XmlElement(name = Elements.NAME_PREFIX, required = false)
     private final String namePrefix;
     @XmlElement(name = Elements.NAME_PREFIX_UNMASKED, required = false)
     private final String namePrefixUnmasked;
     @XmlElement(name = Elements.NAME_TITLE, required = false)
     private final String nameTitle;
     @XmlElement(name = Elements.NAME_TITLE_UNMASKED, required = false)
     private final String nameTitleUnmasked;
     @XmlElement(name = Elements.NAME_SUFFIX_UNMASKED, required = false)
     private final String nameSuffixUnmasked;
     @XmlElement(name = Elements.COMPOSITE_NAME, required = false)
     private final String compositeName;
     @XmlElement(name = Elements.COMPOSITE_NAME_UNMASKED, required = false)
     private final String compositeNameUnmasked;
     @XmlElement(name = Elements.NOTE_MESSAGE, required = false)
     private final String noteMessage;
     @XmlElement(name = Elements.NAME_CHANGED_DATE, required = false)
     @XmlJavaTypeAdapter(DateTimeAdapter.class)
     private final DateTime nameChangedDate;
     @XmlElement(name = Elements.SUPPRESS_NAME, required = false)
     private final boolean suppressName;
     @XmlElement(name = CoreConstants.CommonElements.VERSION_NUMBER, required = false)
     private final Long versionNumber;
     @XmlElement(name = CoreConstants.CommonElements.OBJECT_ID, required = false)
     private final String objectId;
     @XmlElement(name = Elements.DEFAULT_VALUE, required = false)
     private final boolean defaultValue;
     @XmlElement(name = Elements.ACTIVE, required = false)
     private final boolean active;
     @XmlElement(name = Elements.ID, required = false)
     private final String id;
     @SuppressWarnings("unused")
     @XmlAnyElement
     private final Collection<Element> _futureElements = null;
 
     /**
      * Private constructor used only by JAXB.
      * 
      */
     private EntityName() {
         this.nameSuffix = null;
         this.entityId = null;
         this.nameType = null;
         this.firstName = null;
         this.firstNameUnmasked = null;
         this.middleName = null;
         this.middleNameUnmasked = null;
         this.lastName = null;
         this.lastNameUnmasked = null;
         this.namePrefix = null;
         this.namePrefixUnmasked = null;
         this.nameTitle = null;
         this.nameTitleUnmasked = null;
         this.nameSuffixUnmasked = null;
         this.compositeName = null;
         this.compositeNameUnmasked = null;
         this.noteMessage = null;
         this.nameChangedDate = null;
         this.suppressName = false;
         this.versionNumber = null;
         this.objectId = null;
         this.defaultValue = false;
         this.active = false;
         this.id = null;
     }
 
     private EntityName(Builder builder) {
         this.nameSuffix = builder.getNameSuffix();
         this.entityId = builder.getEntityId();
         this.nameType = builder.getNameType() != null ? builder.getNameType().build() : null;
         this.firstName = builder.getFirstName();
         this.firstNameUnmasked = builder.getFirstNameUnmasked();
         this.middleName = builder.getMiddleName();
         this.middleNameUnmasked = builder.getMiddleNameUnmasked();
         this.lastName = builder.getLastName();
         this.lastNameUnmasked = builder.getLastNameUnmasked();
         this.namePrefix = builder.getNamePrefix();
         this.namePrefixUnmasked = builder.getNamePrefixUnmasked();
         this.nameTitle = builder.getNameTitle();
         this.nameTitleUnmasked = builder.getNameTitleUnmasked();
         this.nameSuffixUnmasked = builder.getNameSuffixUnmasked();
         this.compositeName = builder.getCompositeName();
         this.compositeNameUnmasked = builder.getCompositeNameUnmasked();
         this.noteMessage = builder.getNoteMessage();
         this.nameChangedDate = builder.getNameChangedDate();
         this.suppressName = builder.isSuppressName();
         this.versionNumber = builder.getVersionNumber();
         this.objectId = builder.getObjectId();
         this.defaultValue = builder.isDefaultValue();
         this.active = builder.isActive();
         this.id = builder.getId();
     }
 
     @Override
     public String getNameSuffix() {
         return this.nameSuffix;
     }
 
     @Override
     public String getEntityId() {
         return this.entityId;
     }
 
     @Override
     public CodedAttribute getNameType() {
         return this.nameType;
     }
 
     @Override
     public String getFirstName() {
         return this.firstName;
     }
 
     @Override
     public String getFirstNameUnmasked() {
         return this.firstNameUnmasked;
     }
 
     @Override
     public String getMiddleName() {
         return this.middleName;
     }
 
     @Override
     public String getMiddleNameUnmasked() {
         return this.middleNameUnmasked;
     }
 
     @Override
     public String getLastName() {
         return this.lastName;
     }
 
     @Override
     public String getLastNameUnmasked() {
         return this.lastNameUnmasked;
     }
 
     @Override
     public String getNamePrefix() {
         return this.namePrefix;
     }
 
     @Override
     public String getNamePrefixUnmasked() {
         return this.namePrefixUnmasked;
     }
 
     @Override
     public String getNameTitle() {
         return this.nameTitle;
     }
 
     @Override
     public String getNameTitleUnmasked() {
         return this.nameTitleUnmasked;
     }
 
     @Override
     public String getNameSuffixUnmasked() {
         return this.nameSuffixUnmasked;
     }
 
     @Override
     public String getCompositeName() {
         return this.compositeName;
     }
 
     @Override
     public String getCompositeNameUnmasked() {
         return this.compositeNameUnmasked;
     }
 
     @Override
     public String getNoteMessage() {
         return this.noteMessage;
     }
 
     @Override
     public DateTime getNameChangedDate() {
         return this.nameChangedDate;
     }
 
     @Override
     public boolean isSuppressName() {
         return this.suppressName;
     }
 
     @Override
     public Long getVersionNumber() {
         return this.versionNumber;
     }
 
     @Override
     public String getObjectId() {
         return this.objectId;
     }
 
     @Override
     public boolean isDefaultValue() {
         return this.defaultValue;
     }
 
     @Override
     public boolean isActive() {
         return this.active;
     }
 
     @Override
     public String getId() {
         return this.id;
     }
 
 
     /**
      * A builder which can be used to construct {@link EntityName} instances.  Enforces the constraints of the {@link EntityNameContract}.
      * 
      */
     public final static class Builder
         implements Serializable, ModelBuilder, EntityNameContract
     {
 
         private String nameSuffix;
         private String entityId;
         private CodedAttribute.Builder nameType;
         private String firstName;
         private String middleName;
         private String lastName;
         private String namePrefix;
         private String nameTitle;
         private String noteMessage;
         private DateTime nameChangedDate;
         private boolean suppressName;
         private Long versionNumber;
         private String objectId;
         private boolean defaultValue;
         private boolean active;
         private String id;
 
         private Builder() { }
 
         public static Builder create() {
             return new Builder();
         }
 
         public static Builder create(EntityNameContract contract) {
             if (contract == null) {
                 throw new IllegalArgumentException("contract was null");
             }
             Builder builder = create();
             builder.setNameSuffix(contract.getNameSuffix());
             builder.setEntityId(contract.getEntityId());
             if (contract.getNameType() != null) {
                 builder.setNameType(CodedAttribute.Builder.create(contract.getNameType()));
             }
             builder.setFirstName(contract.getFirstName());
             builder.setMiddleName(contract.getMiddleName());
             builder.setLastName(contract.getLastName());
             builder.setNamePrefix(contract.getNamePrefix());
             builder.setNameTitle(contract.getNameTitle());
             builder.setNoteMessage(contract.getNoteMessage());
             builder.setNameChangedDate(contract.getNameChangedDate());
             builder.setSuppressName(contract.isSuppressName());
             builder.setVersionNumber(contract.getVersionNumber());
             builder.setObjectId(contract.getObjectId());
             builder.setDefaultValue(contract.isDefaultValue());
             builder.setActive(contract.isActive());
             builder.setId(contract.getId());
             return builder;
         }
 
         public EntityName build() {
             return new EntityName(this);
         }
 
         @Override
         public String getNameSuffix() {
             if (isSuppressName()) {
                 return KimConstants.RESTRICTED_DATA_MASK;
             }
             return this.nameSuffix;
         }
 
         @Override
         public String getEntityId() {
             return this.entityId;
         }
 
         @Override
         public CodedAttribute.Builder getNameType() {
             return this.nameType;
         }
 
         @Override
         public String getFirstName() {
             if (isSuppressName()) {
                 return KimConstants.RESTRICTED_DATA_MASK;
             }
             return this.firstName;
         }
 
         @Override
         public String getFirstNameUnmasked() {
             return this.firstName;
         }
 
         @Override
         public String getMiddleName() {
             if (isSuppressName()) {
                 return KimConstants.RESTRICTED_DATA_MASK;
             }
             return this.middleName;
         }
 
         @Override
         public String getMiddleNameUnmasked() {
             return this.middleName;
         }
 
         @Override
         public String getLastName() {
             if (isSuppressName()) {
                 return KimConstants.RESTRICTED_DATA_MASK;
             }
             return this.lastName;
         }
 
         @Override
         public String getLastNameUnmasked() {
             return this.lastName;
         }
 
         @Override
         public String getNamePrefix() {
             if (isSuppressName()) {
                 return KimConstants.RESTRICTED_DATA_MASK;
             }
             return this.namePrefix;
         }
 
         @Override
         public String getNamePrefixUnmasked() {
             return this.namePrefix;
         }
 
         @Override
         public String getNameTitle() {
             if (isSuppressName()) {
                 return KimConstants.RESTRICTED_DATA_MASK;
             }
             return this.nameTitle;
         }
 
         @Override
         public String getNameTitleUnmasked() {
             return this.nameTitle;
         }
 
         @Override
         public String getNameSuffixUnmasked() {
             return this.nameSuffix;
         }
 
         @Override
         public String getCompositeName() {
             if (isSuppressName()) {
                 return KimConstants.RESTRICTED_DATA_MASK;
             }
             return getCompositeNameUnmasked();
         }
 
         @Override
         public String getCompositeNameUnmasked() {
             return getLastName() + ", " + getFirstName() + (getMiddleName()==null?"":" " + getMiddleName());
         }
 
         @Override
         public String getNoteMessage() {
             return this.noteMessage;
         }
 
         @Override
         public DateTime getNameChangedDate() {
             return this.nameChangedDate;
         }
 
         @Override
         public boolean isSuppressName() {
             return this.suppressName;
         }
 
         @Override
         public Long getVersionNumber() {
             return this.versionNumber;
         }
 
         @Override
         public String getObjectId() {
             return this.objectId;
         }
 
         @Override
         public boolean isDefaultValue() {
             return this.defaultValue;
         }
 
         @Override
         public boolean isActive() {
             return this.active;
         }
 
         @Override
         public String getId() {
             return this.id;
         }
 
         public void setNameSuffix(String nameSuffix) {
             this.nameSuffix = nameSuffix;
         }
 
         public void setEntityId(String entityId) {
             this.entityId = entityId;
         }
 
         public void setNameType(CodedAttribute.Builder nameType) {
             this.nameType = nameType;
         }
 
         public void setFirstName(String firstName) {
             this.firstName = firstName;
         }
 
         public void setMiddleName(String middleName) {
 
             this.middleName = middleName;
         }
 
         public void setLastName(String lastName) {
             this.lastName = lastName;
         }
 
         public void setNamePrefix(String namePrefix) {
             this.namePrefix = namePrefix;
         }
 
         public void setNameTitle(String nameTitle) {
             this.nameTitle = nameTitle;
         }
 
         public void setNoteMessage(String noteMessage) {
             this.noteMessage = noteMessage;
         }
 
         public void setNameChangedDate(DateTime nameChangedDate) {
             this.nameChangedDate = nameChangedDate;
         }
 
         private void setSuppressName(boolean suppressName) {
             this.suppressName = suppressName;
         }
 
         public void setVersionNumber(Long versionNumber) {
             this.versionNumber = versionNumber;
         }
 
         public void setObjectId(String objectId) {
             this.objectId = objectId;
         }
 
         public void setDefaultValue(boolean defaultValue) {
             this.defaultValue = defaultValue;
         }
 
         public void setActive(boolean active) {
             this.active = active;
         }
 
         public void setId(String id) {
             if (StringUtils.isWhitespace(id)) {
                 throw new IllegalArgumentException("id is blank");
             }
             this.id = id;
         }
 
     }
 
 
     /**
      * Defines some internal constants used on this class.
      * 
      */
     static class Constants {
 
         final static String ROOT_ELEMENT_NAME = "entityName";
         final static String TYPE_NAME = "EntityNameType";
     }
 
 
     /**
      * A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.
      * 
      */
     static class Elements {
 
         final static String NAME_SUFFIX = "nameSuffix";
         final static String ENTITY_ID = "entityId";
         final static String NAME_TYPE = "nameType";
         final static String FIRST_NAME = "firstName";
         final static String FIRST_NAME_UNMASKED = "firstNameUnmasked";
         final static String MIDDLE_NAME = "middleName";
         final static String MIDDLE_NAME_UNMASKED = "middleNameUnmasked";
         final static String LAST_NAME = "lastName";
         final static String LAST_NAME_UNMASKED = "lastNameUnmasked";
         final static String NAME_PREFIX = "namePrefix";
         final static String NAME_PREFIX_UNMASKED = "namePrefixUnmasked";
         final static String NAME_TITLE = "nameTitle";
         final static String NAME_TITLE_UNMASKED = "nameTitleUnmasked";
         final static String NAME_SUFFIX_UNMASKED = "nameSuffixUnmasked";
         final static String COMPOSITE_NAME = "compositeName";
         final static String COMPOSITE_NAME_UNMASKED = "compositeNameUnmasked";
         final static String NOTE_MESSAGE = "noteMessage";
         final static String NAME_CHANGED_DATE= "nameChangedDate";
         final static String SUPPRESS_NAME = "suppressName";
         final static String DEFAULT_VALUE = "defaultValue";
         final static String ACTIVE = "active";
         final static String ID = "id";
 
     }
 
 }