/**
    * Copyright 2010 The Kuali Foundation 
    *
    * Licensed under the the Educational Community License, Version 1.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/ecl1.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.student.enrollment.lui.dto;
  
  import org.kuali.student.core.dto.MetaInfo;
  import org.kuali.student.core.ws.binding.JaxbAttributeMapListAdapter;
  
  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 java.io.Serializable;
  import java.util.Date;
  import java.util.Map;
  import org.kuali.student.common.dto.HasAttributesAndMetaInfo;
  import org.kuali.student.enrollment.lui.infc.LuiInfc;
  
  
  /**
   * Detailed information about a single LUI.
   */
  
  @XmlAccessorType(XmlAccessType.FIELD)
  public class LuiInfo extends HasAttributesAndMetaInfo
    implements Serializable, LuiInfc {
  
      private static final long serialVersionUID = 1L;
  
      @XmlElement
      private String luiCode;
  
      @XmlElement
      private String cluId;
  
      @XmlElement(name = "atpKey")
      private String atpKey;
  
      @XmlElement
      private Integer maxSeats;
  
      @XmlElement
      private Date effectiveDate;
  
      @XmlElement
      private Date expirationDate;
  
      @XmlAttribute
      private String state;
  
      @XmlAttribute
      private String id;
  
      /**
       * Code identifier/name for the LUI. This is typically used in
       * human readable form (e.g. ENGL 100 section 123).
       */
      @Override
      public String getLuiCode() {
          return luiCode;
      }
  
      @Override
      public void setLuiCode(String luiCode) {
          this.luiCode = luiCode;
      }
  
  
      /**
       * Unique identifier for a Canonical Learning Unit (CLU).
       */
      @Override
      public String getCluId() {
          return cluId;
      }
  
      @Override
      public void setCluId(String cluId) {
          this.cluId = cluId;
      }
  
  
      /**
       * Unique identifier for an Academic Time Period (ATP).
       */
     @Override
     public String getAtpKey() {
         return atpKey;
     }
 
     @Override
     public void setAtpKey(String atpKey) {
         this.atpKey = atpKey;
     }
 
 
     /**
      * Maximum number of "seats" that the LUI will hold for registration.
      */
     @Override
     public Integer getMaxSeats() {
         return maxSeats;
     }
 
     @Override
     public void setMaxSeats(Integer maxSeats) {
         this.maxSeats = maxSeats;
     }
 
 
     /**
      * Date and time that this LUI 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.
      */
     @Override
     public Date getEffectiveDate() {
         return effectiveDate;
     }
 
     public void setEffectiveDate(Date effectiveDate) {
         this.effectiveDate = effectiveDate;
     }
 
 
     /**
      * Date and time that this LUI 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;
     }
 
     /**
      * The current status of the LUI. The values for this field are
      * constrained to those in the luState enumeration. A separate
      * setup operation does not exist for retrieval of the meta data
      * around this value.
      */
 
     public String getState() {
         return state;
     }
 
     public void setState(String state) {
         this.state = state;
     }
 
 
     /**
      * Unique identifier for a Learning Unit Instance (LUI). This is
      * optional, due to the identifier being set at the time of
      * creation. Once the LUI has been created, this should be seen as
      * required.
      */
 
     public String getId() {
         return id;
     }
 
     public void setId(String id) {
         this.id = id;
     }
 }