IBlockoutManager

All Known Implementing Classes:

PentahoBlockoutManager
```
public interface IBlockoutManager
```
Author:

wseyler Interface for managing Block-outs (time when schedules should NOT be executed)

Field Summary

Fields
Modifier and Type Field and Description

static String BLOCK_OUT_JOB_NAME

static String DURATION_PARAM

static String SCHEDULED_FIRE_TIME

static String TIME_ZONE_PARAM

Fields
Modifier and Type	Field and Description
`static String`	`BLOCK_OUT_JOB_NAME`
`static String`	`DURATION_PARAM`
`static String`	`SCHEDULED_FIRE_TIME`
`static String`	`TIME_ZONE_PARAM`

Method Summary

Methods
Modifier and Type	Method and Description
`IJobTrigger`	`getBlockOut(String blockOutJobId)`
`List<Job>`	`getBlockOutJobs()`
`boolean`	`isPartiallyBlocked(IJobTrigger scheduleJobTrigger)`
`boolean`	`shouldFireNow()`
`List<IJobTrigger>`	`willBlockSchedules(IJobTrigger testBlockOutJobTrigger)`
`boolean`	`willFire(IJobTrigger scheduleJobTrigger)`

- Field Detail
  - DURATION_PARAM
```
static final String DURATION_PARAM
```
    See Also:
    Constant Field Values
  - TIME_ZONE_PARAM
```
static final String TIME_ZONE_PARAM
```
    See Also:
    Constant Field Values
  - BLOCK_OUT_JOB_NAME
```
static final String BLOCK_OUT_JOB_NAME
```
    See Also:
    Constant Field Values
  - SCHEDULED_FIRE_TIME
```
static final String SCHEDULED_FIRE_TIME
```
    See Also:
    Constant Field Values
- Method Detail
  - getBlockOut
```
IJobTrigger getBlockOut(String blockOutJobId)
```
    Parameters:
    blockOutJobId -
    
    Returns:
    a IBlockOutTrigger that represents the blockOut with the name blockOutName
    
    Throws:
    
    SchedulerException
  - getBlockOutJobs
```
List<Job> getBlockOutJobs()
```
    Returns:
    a list of jobs essentially should be used instead of getBlockOuts which is deprecated
  - willFire
```
boolean willFire(IJobTrigger scheduleJobTrigger)
```
    Parameters:
    scheduleJobTrigger - IJobTrigger
    
    Returns:
    whether the IJobTrigger will fire, at least once, given the current list of IJobTriggers
    
    Throws:
    
    SchedulerException
  - shouldFireNow
```
boolean shouldFireNow()
```
    Returns:
    true if there are no current blockOuts active at the moment this method is called
    
    Throws:
    
    SchedulerException
  - willBlockSchedules
```
List<IJobTrigger> willBlockSchedules(IJobTrigger testBlockOutJobTrigger)
```
    Parameters:
    testBlockOutJobTrigger -
    
    Returns:
    the List of IJobTriggers which would be blocked by the IJobTrigger
    
    Throws:
    
    SchedulerException
  - isPartiallyBlocked
```
boolean isPartiallyBlocked(IJobTrigger scheduleJobTrigger)
```
    Parameters:
    scheduleJobTrigger - IJobTrigger
    
    Returns:
    whether the IJobTrigger is blocked, at least partially, by at least a single IJobTrigger, provided the list of registered IJobTriggers
    
    Throws:
    
    SchedulerException

Interface IBlockoutManager

Field Summary

Method Summary

Field Detail

DURATION_PARAM

TIME_ZONE_PARAM

BLOCK_OUT_JOB_NAME

SCHEDULED_FIRE_TIME

Method Detail

getBlockOut

getBlockOutJobs

willFire

shouldFireNow

willBlockSchedules

isPartiallyBlocked