/**
    * Copyright 2010 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.osedu.org/licenses/ECL-2.0
    *
    * 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.student.core.person.dto;
  
  import java.io.Serializable;
  import java.util.Date;
  import java.util.HashMap;
  import java.util.Map;
  
  import javax.xml.bind.annotation.XmlAccessType;
  import javax.xml.bind.annotation.XmlAccessorType;
  import javax.xml.bind.annotation.XmlAttribute;
  import javax.xml.bind.annotation.XmlElement;
  import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
  
  import org.kuali.student.common.dto.HasAttributes;
  import org.kuali.student.common.dto.Idable;
  import org.kuali.student.common.dto.MetaInfo;
  import org.kuali.student.core.ws.binding.JaxbAttributeMapListAdapter;
  
  /**
   *Detailed information about a person's citizenship.
   */ 
  @XmlAccessorType(XmlAccessType.FIELD)
  public class PersonCitizenshipInfo implements Serializable, Idable, HasAttributes {
  
      private static final long serialVersionUID = 1L;
  
      @XmlElement
      private String personId;
  
      @XmlElement
      private String countryOfCitizenshipCode;
  
      @XmlElement
      private String countryOfCitizenshipName;
  
      @XmlElement
      private Date effectiveDate;
  
      @XmlElement
      private Date expirationDate;
  
      @XmlElement
      @XmlJavaTypeAdapter(JaxbAttributeMapListAdapter.class)
      private Map<String, String> attributes;
  
      @XmlElement
      private MetaInfo metaInfo;
  
      @XmlAttribute
      private String id;
  
      /**
       * Unique identifier for a person record. This is optional, due to the identifier being set at the time of creation of the person. Once the person has been created, this should be seen as required.
       */
      public String getPersonId() {
          return personId;
      }
  
      public void setPersonId(String personId) {
          this.personId = personId;
      }
  
      /**
       * Code for the country of citizenship
       */
      public String getCountryOfCitizenshipCode() {
          return countryOfCitizenshipCode;
      }
  
      public void setCountryOfCitizenshipCode(String countryOfCitizenshipCode) {
          this.countryOfCitizenshipCode = countryOfCitizenshipCode;
      }
  
      /**
       * Name of country of citizenship
       */
      public String getCountryOfCitizenshipName() {
          return countryOfCitizenshipName;
      }
  
      public void setCountryOfCitizenshipName(String countryOfCitizenshipName) {
          this.countryOfCitizenshipName = countryOfCitizenshipName;
      }
  
     /**
      * Date and time that this citizenship became effective. This is a similar concept to the effective date on enumerated values. When an expiration date has been specified, this field must be less than or equal to the expiration date.
      */
     public Date getEffectiveDate() {
         return effectiveDate;
     }
 
     public void setEffectiveDate(Date effectiveDate) {
         this.effectiveDate = effectiveDate;
     }
 
     /**
      * Date and time that this citizenship expires. This is a similar concept to the expiration date on enumerated values. If specified, this should be greater than or equal to the effective date. If this field is not specified, then no expiration date has been currently defined and should automatically be considered greater than the effective date.
      */
     public Date getExpirationDate() {
         return expirationDate;
     }
 
     public void setExpirationDate(Date expirationDate) {
         this.expirationDate = expirationDate;
     }
 
     /**
      * List of key/value pairs, typically used for dynamic attributes.
      */
     public Map<String, String> getAttributes() {
         if (attributes == null) {
             attributes = new HashMap<String, String>();
         }
         return attributes;
     }
 
     public void setAttributes(Map<String, String> attributes) {
         this.attributes = attributes;
     }
 
     /**
      * Create and last update info for the structure. This is optional and treated as read only since the data is set by the internals of the service during maintenance operations.
      */
     public MetaInfo getMetaInfo() {
         return metaInfo;
     }
 
     public void setMetaInfo(MetaInfo metaInfo) {
         this.metaInfo = metaInfo;
     }
 
     /**
      * Unique identifier for the citizenship record. This is set by the service to be able to determine changes and alterations to the structure as well as provides a handle for searches. This structure is not accessible through unique operations, and it is strongly recommended that no external references to this particular identifier be maintained. Once this identifier is set by the service, it should be seen as required and readonly.
      */
     public String getId() {
         return id;
     }
 
     public void setId(String id) {
         this.id = id;
     }
 }