Schedule

java.lang.Object
- org.kepler.workflowscheduler.gui.Schedule

public class Schedule
extends java.lang.Object

A class represents a schedule object.

Author:: tao

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DAY`
`static java.lang.String`	`HOUR`
`static java.lang.String`	`MONTH`
`static int`	`NEGTIVEONE`
`static java.lang.String`	`WEEK`

Constructor Summary

Constructors
Constructor and Description

Schedule()

Constructors
Constructor and Description
`Schedule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getEndTime()` Gets the end time of the schedule
`java.lang.String`	`getEndTimeFormat()` Get the format of the end time string
`java.lang.String`	`getEndTimeLabel()` Get the label for display the end time.
`java.lang.String`	`getEndTimeZoneID()` Get the time zone id of the end time
`int`	`getInterval()` Get the interval of the schedule
`java.lang.String`	`getIntervalUnit()` Get the interval unit
`java.lang.String`	`getKarLSID()` Get the kar id associated with the workflow schedule object
`java.lang.String`	`getStartTime()` Get the start time of the schedule
`java.lang.String`	`getStartTimeFormat()` Get the format of the start time string
`java.lang.String`	`getStartTimeLabel()` Get the label for display the start time.
`java.lang.String`	`getStartTimeZoneID()` Get the time zone id for the start time
`java.lang.String`	`getWorkflowId()` Get the workflow id associated with this schedule
`java.lang.String`	`getWorkflowJobName()` Get the workflow job name.
`Repository`	`getWorkflowLocation()` Get the workflow location repository
`java.lang.String`	`getWorkflowName()` Get the workflow name associated with the schedule
`Repository`	`getWorkflowRunDestination()` Get the destination repository which will store the workflwo run
`WorkflowRunEngine`	`getWorkflowRunEngine()` Get the workflow run engine which will run the workflow
`boolean`	`isEnabled()` If the scheduler is enabled
`boolean`	`isValid()` If the schedule is valid
`void`	`setEnabled(boolean enabled)` Set the status of the schedule
`void`	`setEndTime(java.lang.String endTime)` Set the end time of the schedule
`void`	`setEndTimeFormat(java.lang.String endTimeFormat)` Set the format of the end time string
`void`	`setEndTimeLabel(java.lang.String endTimeLabel)` Set the label for end time.
`void`	`setEndTimeZoneID(java.lang.String endTimeZoneID)` Set the end time zone id.
`void`	`setInterval(java.lang.String interval)` Set the interval of the schedule
`void`	`setIntervalUnit(java.lang.String intervalUnit)` Set the interval unit
`void`	`setKarLSID(java.lang.String karLSID)` Set the kar file id
`void`	`setStartTime(java.lang.String startTime)` Set the start time of the schedule
`void`	`setStartTimeFormat(java.lang.String startTimeFormat)` Set the format of start time string.
`void`	`setStartTimeLabel(java.lang.String startTimeLabel)` Set the start time label for display
`void`	`setStartTimeZoneID(java.lang.String startTimeZoneID)` Set the time zone id for the start time
`void`	`setWorkflowId(java.lang.String workflowId)` Set the workflwo id to this schedule
`void`	`setWorkflowJobName(java.lang.String workflowJobName)` Set the workflow job name
`void`	`setWorkflowLocation(Repository workflowLocation)` Set the workflow location repository
`void`	`setWorkflowName(java.lang.String workflowName)` Set workflow name to this schedule object
`void`	`setWorkflowRunDestination(Repository workflowRunDestination)` Set the destination repository which will store the workflow run
`void`	`setWorkflowRunEngine(WorkflowRunEngine workflowRunEngine)` Set the workflow run engine which will run the workflow

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - HOUR
```
public static final java.lang.String HOUR
```
    See Also:
    
    Constant Field Values
  - DAY
```
public static final java.lang.String DAY
```
    See Also:
    
    Constant Field Values
  - WEEK
```
public static final java.lang.String WEEK
```
    See Also:
    
    Constant Field Values
  - MONTH
```
public static final java.lang.String MONTH
```
    See Also:
    
    Constant Field Values
  - NEGTIVEONE
```
public static final int NEGTIVEONE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Schedule
```
public Schedule()
```
- Method Detail
  - getStartTimeLabel
```
public java.lang.String getStartTimeLabel()
```
    Get the label for display the start time. It is only for display
    
    Returns:
    
    the label of the start time.
  - setStartTimeLabel
```
public void setStartTimeLabel(java.lang.String startTimeLabel)
```
    Set the start time label for display
    
    Parameters:
    
    startTimeLabel - the label will be displayed.
  - getStartTime
```
public java.lang.String getStartTime()
```
    Get the start time of the schedule
    
    Returns:
    
    the start time
  - setStartTime
```
public void setStartTime(java.lang.String startTime)
```
    Set the start time of the schedule
    
    Parameters:
    
    startTime - the start time of the schedule
  - getStartTimeFormat
```
public java.lang.String getStartTimeFormat()
```
    Get the format of the start time string
    
    Returns:
    
    the format of start time string. It can be null.
  - setStartTimeFormat
```
public void setStartTimeFormat(java.lang.String startTimeFormat)
```
    Set the format of start time string.
    
    Parameters:
    
    startTimeFormat - the specified foramt for the start time string
  - getStartTimeZoneID
```
public java.lang.String getStartTimeZoneID()
```
    Get the time zone id for the start time
    
    Returns:
    
    time zone id of the start time. It can be null
  - setStartTimeZoneID
```
public void setStartTimeZoneID(java.lang.String startTimeZoneID)
```
    Set the time zone id for the start time
    
    Parameters:
    
    startTimeZoneID -
  - getEndTimeLabel
```
public java.lang.String getEndTimeLabel()
```
    Get the label for display the end time. It is only for display
    
    Returns:
    
    the label
  - setEndTimeLabel
```
public void setEndTimeLabel(java.lang.String endTimeLabel)
```
    Set the label for end time.
    
    Parameters:
    
    endTimeLabel -
  - getEndTime
```
public java.lang.String getEndTime()
```
    Gets the end time of the schedule
    
    Returns:
    
    the end time
  - setEndTime
```
public void setEndTime(java.lang.String endTime)
```
    Set the end time of the schedule
    
    Parameters:
    
    endTime - the end time of the schedule
  - getEndTimeFormat
```
public java.lang.String getEndTimeFormat()
```
    Get the format of the end time string
    
    Returns:
    
    the format of the end time string. It can be null
  - setEndTimeFormat
```
public void setEndTimeFormat(java.lang.String endTimeFormat)
```
    Set the format of the end time string
    
    Parameters:
    
    endTimeFormat - the format of the end time string.
  - getEndTimeZoneID
```
public java.lang.String getEndTimeZoneID()
```
    Get the time zone id of the end time
    
    Returns:
    
    the time zone id of the end time. It can be null
  - setEndTimeZoneID
```
public void setEndTimeZoneID(java.lang.String endTimeZoneID)
```
    Set the end time zone id.
    
    Parameters:
    
    endTimeZoneID - the time zone id of the end time.
  - getInterval
```
public int getInterval()
```
    Get the interval of the schedule
    
    Returns:
    
    the interval
  - setInterval
```
public void setInterval(java.lang.String interval)
                 throws java.lang.NumberFormatException
```
    Set the interval of the schedule
    
    Parameters:
    
    interval - of the schedule
    
    Throws:
    
    java.lang.NumberFormatException
  - getIntervalUnit
```
public java.lang.String getIntervalUnit()
```
    Get the interval unit
    
    Returns:
    
    the unit of the interval
  - setIntervalUnit
```
public void setIntervalUnit(java.lang.String intervalUnit)
                     throws java.lang.Exception
```
    Set the interval unit
    
    Parameters:
    
    intervalUnit - the unit of the interval
    
    Throws:
    
    java.lang.Exception
  - isEnabled
```
public boolean isEnabled()
```
    If the scheduler is enabled
    
    Returns:
    
    true if it is enabled
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Set the status of the schedule
    
    Parameters:
    
    enabled - true if it is enabled
  - getWorkflowId
```
public java.lang.String getWorkflowId()
```
    Get the workflow id associated with this schedule
    
    Returns:
    
    the id of the workflow (in slid format)
  - setWorkflowId
```
public void setWorkflowId(java.lang.String workflowId)
```
    Set the workflwo id to this schedule
    
    Parameters:
    
    workflowId -
  - getWorkflowName
```
public java.lang.String getWorkflowName()
```
    Get the workflow name associated with the schedule
    
    Returns:
  - setWorkflowName
```
public void setWorkflowName(java.lang.String workflowName)
```
    Set workflow name to this schedule object
    
    Parameters:
    
    workflowName -
  - getKarLSID
```
public java.lang.String getKarLSID()
```
    Get the kar id associated with the workflow schedule object
    
    Returns:
    
    kar file id in lsid format
  - setKarLSID
```
public void setKarLSID(java.lang.String karLSID)
```
    Set the kar file id
    
    Parameters:
    
    karId - id of the kar file in lsid format
  - isValid
```
public boolean isValid()
```
    If the schedule is valid
    
    Returns:
    
    true if workflowId, workflowName, karId, startTime, endTime and interval unit are not null and interval is greater than 0.
  - getWorkflowJobName
```
public java.lang.String getWorkflowJobName()
```
    Get the workflow job name. This the key to identify a schedule
    
    Returns:
  - setWorkflowJobName
```
public void setWorkflowJobName(java.lang.String workflowJobName)
```
    Set the workflow job name
    
    Parameters:
    
    workflowJobName -
  - getWorkflowRunEngine
```
public WorkflowRunEngine getWorkflowRunEngine()
```
    Get the workflow run engine which will run the workflow
  - setWorkflowRunEngine
```
public void setWorkflowRunEngine(WorkflowRunEngine workflowRunEngine)
```
    Set the workflow run engine which will run the workflow
    
    Parameters:
    
    workflowRunEngine -
  - getWorkflowRunDestination
```
public Repository getWorkflowRunDestination()
```
    Get the destination repository which will store the workflwo run
    
    Returns:
  - setWorkflowRunDestination
```
public void setWorkflowRunDestination(Repository workflowRunDestination)
```
    Set the destination repository which will store the workflow run
    
    Parameters:
    
    workflowRunDestination -
  - getWorkflowLocation
```
public Repository getWorkflowLocation()
```
    Get the workflow location repository
    
    Returns:
  - setWorkflowLocation
```
public void setWorkflowLocation(Repository workflowLocation)
```
    Set the workflow location repository
    
    Parameters:
    
    workflowLocation -

Class Schedule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HOUR

DAY

WEEK

MONTH

NEGTIVEONE

Constructor Detail

Schedule

Method Detail

getStartTimeLabel

setStartTimeLabel

getStartTime

setStartTime

getStartTimeFormat

setStartTimeFormat

getStartTimeZoneID

setStartTimeZoneID

getEndTimeLabel

setEndTimeLabel

getEndTime

setEndTime

getEndTimeFormat

setEndTimeFormat

getEndTimeZoneID

setEndTimeZoneID

getInterval

setInterval

getIntervalUnit

setIntervalUnit

isEnabled

setEnabled

getWorkflowId

setWorkflowId

getWorkflowName

setWorkflowName

getKarLSID

setKarLSID

isValid

getWorkflowJobName

setWorkflowJobName

getWorkflowRunEngine

setWorkflowRunEngine

getWorkflowRunDestination

setWorkflowRunDestination

getWorkflowLocation

setWorkflowLocation