/*
    * Copyright 2009 The Kuali Foundation
    *
    * Licensed under 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.lum.course.dto;
  
  import java.io.Serializable;
  import java.util.ArrayList;
  import java.util.HashMap;
  import java.util.List;
  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.core.dto.HasAttributes;
  import org.kuali.student.core.dto.HasTypeState;
  import org.kuali.student.core.dto.Idable;
  import org.kuali.student.core.dto.MetaInfo;
  import org.kuali.student.core.ws.binding.JaxbAttributeMapListAdapter;
  
  /**
   * Detailed information about a single course.
   *
   * @Author KSContractMojo
   * @Author Kamal
   * @Since Tue May 18 11:30:55 PDT 2010
   * @See <a href="https://test.kuali.org/confluence/display/KULSTU/formatInfo+Structure">FormatInfo</>
   *
   */
  @XmlAccessorType(XmlAccessType.FIELD)
  public class FormatInfo implements Serializable, Idable, HasTypeState, HasAttributes {
  
      private static final long serialVersionUID = 1L;
  
      @XmlElement
      private List<ActivityInfo> activities;
  
      @XmlElement
      @XmlJavaTypeAdapter(JaxbAttributeMapListAdapter.class)
      private Map<String, String> attributes;
  
      @XmlElement
      private MetaInfo metaInfo;
  
      @XmlAttribute
      private String type;
  
      @XmlAttribute
      private String state;
  
      @XmlAttribute
      private String id;
  
      /**
       * 
       */
      public List<ActivityInfo> getActivities() {
          if (activities == null) {
              activities = new ArrayList<ActivityInfo>(0);
          }
          return activities;
      }
  
      public void setActivities(List<ActivityInfo> activities) {
          this.activities = activities;
      }
  
      /**
       * 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 a learning unit type. Once set at create time, this field may not be updated.
      */
     public String getType() {
         return type;
     }
 
     public void setType(String type) {
         this.type = type;
     }
 
     /**
      * The current status of the course. 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. This field may not be updated through updating this structure and must instead be updated through a dedicated operation.
      */
     public String getState() {
         return state;
     }
 
     public void setState(String state) {
         this.state = state;
     }
 
     /**
      * Unique identifier for a Canonical Learning Unit (CLU). This is optional, due to the identifier being set at the time of creation. Once the Format has been created, this should be seen as required.
      */
     public String getId() {
         return id;
     }
 
     public void setId(String id) {
         this.id = id;
     }
 }