/* 
 * Copyright (c) 2010 The Regents of the University of California.
 * All rights reserved.
 *
 * '$Author: crawl $'
 * '$Date: 2010-07-23 17:04:30 -0700 (Fri, 23 Jul 2010) $' 
 * '$Revision: 25146 $'
 * 
 * Permission is hereby granted, without written agreement and without
 * license or royalty fees, to use, copy, modify, and distribute this
 * software and its documentation for any purpose, provided that the above
 * copyright notice and the following two paragraphs appear in all copies
 * of this software.
 *
 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
 * ENHANCEMENTS, OR MODIFICATIONS.
 *
 */
package org.kepler.workflowscheduler.gui;

import org.kepler.objectmanager.repository.Repository;

/**
 * A class represents a schedule object.
 * @author tao
 *
 */
public class Schedule
{
  private static final String UNKNOWN = "unknown";
  private String workflowJobName = null;
  private String workflowId = null;
  private String workflowName = null;
  private String karLSID = null;
  private String startTimeLabel = UNKNOWN;
  private String startTime = null;
  private String startTimeFormat = null;
  private String startTimeZoneID = null;
  private String endTimeLabel = UNKNOWN;
  private String endTime = null;
  private String endTimeFormat = null;
  private String endTimeZoneID = null;
 

  private int interval = NEGTIVEONE;
  private String intervalUnit = null;
  private boolean enabled = true;
  private WorkflowRunEngine workflowRunEngine = null;
  private Repository workflowRunDestination = null;
  private Repository workflowLocation = null;
  public static final String HOUR = "hour";
  public static final String DAY = "day";
  public static final String WEEK = "week";
  public static final String MONTH = "mon";
  public static final int NEGTIVEONE = -1;
  
  
  /**
   * Get the label for display the start time. It is only for display
   * @return the label of the start time.
   */
  public String getStartTimeLabel()
  {
    return this.startTimeLabel;
  }
  
  /**
   * Set the start time label for display
   * @param startTimeLabel the label will be displayed.
   */
  public void setStartTimeLabel(String startTimeLabel)
  {
    this.startTimeLabel = startTimeLabel;
  }
  
  /**
   * Get the start time of the schedule
   * @return the start time
   */
  public String getStartTime()
  {
    return startTime;
  }
  
  /**
   * Set the start time of the schedule
   * @param startTime the start time of the schedule
   */
  public void setStartTime(String startTime)
  {
    this.startTime = startTime;
  }
  
  /**
   * Get the format of the start time string
   * @return the format of start time string. It can be null.
   */
  public String getStartTimeFormat()
  {
    return this.startTimeFormat;
  }

  /**
   * Set the format of start time string.
   * @param startTimeFormat the specified foramt for the start time string
   */
  public void setStartTimeFormat(String startTimeFormat)
  {
    this.startTimeFormat = startTimeFormat;
  }

  /**
   * Get the time zone id for the start time
   * @return time zone id of the start time. It can be null
   */
  public String getStartTimeZoneID()
  {
    return this.startTimeZoneID;
  }

  /**
   * Set the time zone id for the start time
   * @param startTimeZoneID
   */
  public void setStartTimeZoneID(String startTimeZoneID)
  {
    this.startTimeZoneID = startTimeZoneID;
  }
  
  
  /**
   * Get the label for display the end time. It is only for display
   * @return the label
   */
  public String getEndTimeLabel()
  {
    return this.endTimeLabel;
  }
  
  /**
   * Set the label for end time.
   * @param endTimeLabel
   */
  public void setEndTimeLabel(String endTimeLabel)
  {
    this.endTimeLabel = endTimeLabel;
  }
  /**
   * Gets the end time of the schedule
   * @return the end time
   */
  public String getEndTime()
  {
    return endTime;
  }
  
  /**
   * Set the end time of the schedule
   * @param endTime the end time of the schedule
   */
  public void setEndTime(String endTime)
  {
    this.endTime = endTime;
  }
  
  /**
   * Get the format of the end time string  
   * @return the format of the end time string. It can be null
   */
  public String getEndTimeFormat()
  {
    return this.endTimeFormat;
  }

  /**
   * Set the format of the end time string
   * @param endTimeFormat the format of the end time string.
   */
  public void setEndTimeFormat(String endTimeFormat)
  {
    this.endTimeFormat = endTimeFormat;
  }

  /**
   * Get the time zone id of the end time
   * @return the time zone id of the end time. It can be null
   */
  public String getEndTimeZoneID()
  {
    return this.endTimeZoneID;
  }

  /**
   * Set the end time zone id.
   * @param endTimeZoneID the time zone id of the end time.
   */
  public void setEndTimeZoneID(String endTimeZoneID)
  {
    this.endTimeZoneID = endTimeZoneID;
  }
  
  /**
   * Get the interval of the schedule
   * @return the interval
   */
  public int getInterval()
  {
    return interval;
  }
  
  /**
   * Set the interval of the schedule
   * @param interval of the schedule
   */
  public void setInterval(String interval) throws NumberFormatException
  {
    this.interval = Integer.parseInt(interval);
  }
  
  /**
   * Get the interval unit
   * @return the unit of the interval
   */
  public String getIntervalUnit()
  {
    return intervalUnit;
  }
  
  /**
   * Set the interval unit
   * @param intervalUnit the unit of the interval
   */
  public void setIntervalUnit(String intervalUnit) throws Exception
  {
    if(intervalUnit == null)
    {
      throw new Exception("The interval unit couldn't be null");
    }
    else if( !intervalUnit.endsWith(HOUR) && !intervalUnit.equals(DAY) && !intervalUnit.equals(WEEK) && !intervalUnit.equals(MONTH))
    {
      throw new Exception("The interval unit is "+intervalUnit+" but it should be the one of  \"hour\", \"day\", \"week\" or \"mon\"");
    }
    this.intervalUnit = intervalUnit;
  }
  
  /**
   * If the scheduler is enabled
   * @return true if it is enabled
   */
  public boolean isEnabled()
  {
    return enabled;
  }
  
  /**
   * Set the status of the schedule
   * @param enabled  true if it is enabled
   */
  public void setEnabled(boolean enabled)
  {
    this.enabled = enabled;
  }

  /**
   * Get the workflow id associated with this schedule
   * @return the id of the workflow (in slid format)
   */
  public String getWorkflowId()
  {
    return workflowId;
  }

  /**
   * Set the workflwo id to this schedule
   * @param workflowId
   */
  public void setWorkflowId(String workflowId)
  {
    this.workflowId = workflowId;
  }

  /**
   * Get the workflow name associated with the schedule
   * @return
   */
  public String getWorkflowName()
  {
    return workflowName;
  }

  /**
   * Set workflow name to this schedule object
   * @param workflowName
   */
  public void setWorkflowName(String workflowName)
  {
    this.workflowName = workflowName;
  }

  /**
   * Get the kar id associated with the workflow schedule object
   * @return kar file id in lsid format
   */
  public String getKarLSID()
  {
    return karLSID;
  }

  /**
   * Set the kar file id
   * @param karId id of the kar file in lsid format
   */
  public void setKarLSID(String karLSID)
  {
    this.karLSID = karLSID;
  }
  
  /**
   * If the schedule is valid
   * @return true if workflowId, workflowName, karId, startTime, endTime and interval unit are not
   * null and interval is greater than 0.
   */
  public boolean isValid()
  {
    if(workflowId != null && workflowName != null && karLSID != null && startTime != null && 
        endTime != null && interval > 0 && intervalUnit != null && workflowJobName != null)
    {
      return true;
    }
    else
    {
      return false;
    }
  }

  /**
   * Get the workflow job name. This the key to identify a schedule
   * @return
   */
  public String getWorkflowJobName()
  {
    return workflowJobName;
  }

  /**
   * Set the workflow job name
   * @param workflowJobName
   */
  public void setWorkflowJobName(String workflowJobName)
  {
    this.workflowJobName = workflowJobName;
  }

  /**
   * Get the workflow run engine which will run the workflow
   */
  public WorkflowRunEngine getWorkflowRunEngine()
  {
    return workflowRunEngine;
  }

  /**
   * Set the workflow run engine which will run the workflow
   * @param workflowRunEngine
   */
  public void setWorkflowRunEngine(WorkflowRunEngine workflowRunEngine)
  {
    this.workflowRunEngine = workflowRunEngine;
  }

  /**
   * Get the destination repository which will store the workflwo run
   * @return
   */
  public Repository getWorkflowRunDestination()
  {
    return workflowRunDestination;
  }

  /**
   * Set the destination repository which will store the workflow run
   * @param workflowRunDestination
   */
  public void setWorkflowRunDestination(Repository workflowRunDestination)
  {
    this.workflowRunDestination = workflowRunDestination;
  }

  /**
   * Get the workflow location repository
   * @return
   */
  public Repository getWorkflowLocation()
  {
    return workflowLocation;
  }

  /**
   * Set the workflow location repository
   * @param workflowLocation
   */
  public void setWorkflowLocation(Repository workflowLocation)
  {
    this.workflowLocation = workflowLocation;
  }

}