org.pentaho.platform.scheduler2.blockout

Class PentahoBlockoutManager

java.lang.Object

org.pentaho.platform.scheduler2.blockout.PentahoBlockoutManager

All Implemented Interfaces:

IBlockoutManager

public class PentahoBlockoutManager
extends Object
implements IBlockoutManager

Field Summary

Fields inherited from interface org.pentaho.platform.api.scheduler2.IBlockoutManager

BLOCK_OUT_JOB_NAME, DURATION_PARAM, SCHEDULED_FIRE_TIME, TIME_ZONE_PARAM

Constructor Summary

Constructors

Constructor and Description
PentahoBlockoutManager()

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 scheduleTrigger)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PentahoBlockoutManager

public PentahoBlockoutManager()

Method Detail

getBlockOut

public IJobTrigger getBlockOut(String blockOutJobId)

Specified by:

getBlockOut in interface IBlockoutManager

Returns:

a IBlockOutTrigger that represents the blockOut with the name blockOutName

getBlockOutJobs

public List<Job> getBlockOutJobs()

Specified by:

getBlockOutJobs in interface IBlockoutManager

Returns:

a list of jobs essentially should be used instead of getBlockOuts which is deprecated

willFire

public boolean willFire(IJobTrigger scheduleTrigger)

Specified by:

willFire in interface IBlockoutManager

Parameters:

scheduleTrigger - IJobTrigger

Returns:

whether the IJobTrigger will fire, at least once, given the current list of IJobTriggers

shouldFireNow

public boolean shouldFireNow()

Specified by:

shouldFireNow in interface IBlockoutManager

Returns:

true if there are no current blockOuts active at the moment this method is called

willBlockSchedules

public List<IJobTrigger> willBlockSchedules(IJobTrigger testBlockOutJobTrigger)

Specified by:

willBlockSchedules in interface IBlockoutManager

Returns:

the List of IJobTriggers which would be blocked by the IJobTrigger

isPartiallyBlocked

public boolean isPartiallyBlocked(IJobTrigger scheduleJobTrigger)

Specified by:

isPartiallyBlocked in interface IBlockoutManager

Parameters:

scheduleJobTrigger - IJobTrigger

Returns:

whether the IJobTrigger is blocked, at least partially, by at least a single IJobTrigger, provided the list of registered IJobTriggers