SchedulingContext (SeedStack API 18.11.3)

```
public interface SchedulingContext
```
Provides detailed scheduling information for a task.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Date`	`getCurrentFireDate()` actual fire time of the current Task run
`Map<String,?>`	`getDataMap()` The task data map.
`Date`	`getNextFireDate()` fire time of the next Task run
`Date`	`getPreviousFireDate()` fire time of the previous Task run
`Date`	`getScheduledFireDate()` actual scheduled time of the current Task run
`String`	`getTaskName()` TaskName is either : provided through (@Scheduled) annotation generated though (@ScheduledTaskBuilder) instantiation provided through (@ScheduledTaskBuilder) DSL withTaskName method
`long`	`getTaskRuntime()` The amount of time the Task ran for (in milliseconds).
`Date`	`getTriggerEndDate()` Trigger planned end time
`Date`	`getTriggerFinalFireDate()` Trigger planned date of final run
`String`	`getTriggerName()` triggerName is either : provided through (@Scheduled) annotation generated though (@ScheduledTaskBuilder) instantiation provided through (@ScheduledTaskBuilder) DSL withTriggerName method
`int`	`getTriggerPriority()` The Trigger's priority.
`int`	`getTriggerRefireCount()` Number of times the Trigger has been Task refired
`Date`	`getTriggerStartDate()` Trigger planned start time
`boolean`	`isRequestRecovery()` RequestRecovery notify the Scheduler whether or not the Task should be re-executed if a recovery or fail-over situation is encountered.
`boolean`	`isStoreDurably()` Whether or not the Task should remain stored after it is orphaned (no Triggers point to it).
`<T> T`	`unwrap(Class<T> toClass)` Allow to access to unwrap the context to an implementation-specific class.

- Method Detail
  - getTaskName
```
String getTaskName()
```
    TaskName is either :
    - provided through (@Scheduled) annotation
    - generated though (@ScheduledTaskBuilder) instantiation
    - provided through (@ScheduledTaskBuilder) DSL withTaskName method
    Returns:
    
    the task name
  - isRequestRecovery
```
boolean isRequestRecovery()
```
    RequestRecovery notify the Scheduler whether or not the Task should be re-executed if a recovery or fail-over situation is encountered.
    
    Returns:
    
    true if recovery should be attempted, false otherwise
  - isStoreDurably
```
boolean isStoreDurably()
```
    Whether or not the Task should remain stored after it is orphaned (no Triggers point to it).
    
    Returns:
    
    true if the task should be stored durably, false otherwise.
  - getTriggerName
```
String getTriggerName()
```
    triggerName is either :
    - provided through (@Scheduled) annotation
    - generated though (@ScheduledTaskBuilder) instantiation
    - provided through (@ScheduledTaskBuilder) DSL withTriggerName method
    Returns:
    
    the trigger name
  - getTriggerPriority
```
int getTriggerPriority()
```
    The Trigger's priority. When more than one Trigger have the same fire time, the scheduler will fire the one with the highest priority first.
    
    Returns:
    
    the trigger priority
  - getCurrentFireDate
```
Date getCurrentFireDate()
```
    actual fire time of the current Task run
    
    Returns:
    
    the fire date
  - getPreviousFireDate
```
Date getPreviousFireDate()
```
    fire time of the previous Task run
    
    Returns:
    
    the previous fire date
  - getNextFireDate
```
Date getNextFireDate()
```
    fire time of the next Task run
    
    Returns:
    
    the next fire date
  - getTaskRuntime
```
long getTaskRuntime()
```
    The amount of time the Task ran for (in milliseconds). The returned value will be -1 until the Task has actually completed (or thrown an exception), and is therefore generally only useful to TaskListeners.
    
    Returns:
    
    the runtime task in milliseconds
  - getScheduledFireDate
```
Date getScheduledFireDate()
```
    actual scheduled time of the current Task run
    
    Returns:
    
    the scheduled fire date
  - getTriggerRefireCount
```
int getTriggerRefireCount()
```
    Number of times the Trigger has been Task refired
    
    Returns:
    
    the refire count
  - getTriggerFinalFireDate
```
Date getTriggerFinalFireDate()
```
    Trigger planned date of final run
    
    Returns:
    
    the planned final run date
  - getTriggerEndDate
```
Date getTriggerEndDate()
```
    Trigger planned end time
    
    Returns:
    
    the planned end date
  - getTriggerStartDate
```
Date getTriggerStartDate()
```
    Trigger planned start time
    
    Returns:
    
    the planned start date
  - getDataMap
```
Map<String,?> getDataMap()
```
    The task data map.
    
    Returns:
    
    the data map.
  - unwrap
```
<T> T unwrap(Class<T> toClass)
```
    Allow to access to unwrap the context to an implementation-specific class.
    
    Type Parameters:
    
    T - the implementation-specific type.
    
    Parameters:
    
    toClass - the implementation-specific class to access to.
    
    Returns:
    
    the instance implementing the requested type.
    
    Throws:
    
    SeedException - if the class cannot be unwrapped.

Interface SchedulingContext

Method Summary

Method Detail

getTaskName

isRequestRecovery

isStoreDurably

getTriggerName

getTriggerPriority

getCurrentFireDate

getPreviousFireDate

getNextFireDate

getTaskRuntime

getScheduledFireDate

getTriggerRefireCount

getTriggerFinalFireDate

getTriggerEndDate

getTriggerStartDate

getDataMap

unwrap