/**
    * 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.r1.lum.lrc.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.r1.common.dto.HasAttributes;
  import org.kuali.student.r1.common.dto.Idable;
  import org.kuali.student.core.ws.binding.JaxbAttributeMapListAdapter;
  
  /**
   * Detailed information about a grade value.
   *
   * @Author KSContractMojo
   * @Author lindholm
   * @Since Tue Apr 21 13:47:44 PDT 2009
   * @See <a href="https://test.kuali.org/confluence/display/KULSTU/gradeInfo+Structure">GradeInfo</>
   *
   */
  @XmlAccessorType(XmlAccessType.FIELD)
  public class GradeInfo implements Serializable, Idable, HasAttributes {
  
      private static final long serialVersionUID = 1L;
  
      @XmlElement
      private String name;
  
      @XmlElement
      private String value;
  
      @XmlElement
      private String scaleKey;
  
      @XmlElement
      private String rank;
  
      @XmlElement
      private Date effectiveDate;
  
      @XmlElement
      private Date expirationDate;
  
      @XmlElement
      @XmlJavaTypeAdapter(JaxbAttributeMapListAdapter.class)
      private Map<String, String> attributes;
  
      @XmlAttribute
      private String type;
  
      @XmlAttribute(name="key")
      private String id;
  
      /**
       * Name of the grade. This is likely related to the type, value and/or scale, but this is not required.
       */
      public String getName() {
          return name;
      }
  
      public void setName(String name) {
          this.name = name;
      }
  
      /**
       * Value of the grade. Typically corresponds with the short coded form of the grade (ex. "A", "4.0", "97.0%", etc.)
       */
      public String getValue() {
          return value;
      }
  
      public void setValue(String value) {
          this.value = value;
      }
  
      /**
       * Identifier of the scale for this grade value.
       */
     public String getScaleKey() {
         return scaleKey;
     }
 
     public void setScaleKey(String scaleKey) {
         this.scaleKey = scaleKey;
     }
 
     /**
      * Rank of the grade value within the scale. Standards around uniqueness and meaning of value are described in the information about the scale.
      */
     public String getRank() {
         return rank;
     }
 
     public void setRank(String rank) {
         this.rank = rank;
     }
 
     /**
      * Date and time that this grade value 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 grade value 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;
     }
 
     /**
      * Unique identifier for a grade type.
      */
     public String getType() {
         return type;
     }
 
     public void setType(String type) {
         this.type = type;
     }
 
     /**
      * Unique identifier for a grade value.
      */
     public String getId() {
         return id;
     }
 
     public void setId(String id) {
         this.id = id;
     }
 }