Package com.redwood.scheduler.api.model.compatibility_14

Interface JobForecasterComp

All Known Implementing Classes:

JobForecaster

public interface JobForecasterComp

Job forecasting.

Method Summary

Modifier and Type	Method	Description
Iterator<ForecastJob>	forecast(SchedulerSession session, DateTimeZone at)	Deprecated. this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use JobForecaster.forecast(SchedulerSession, DateTimeZone) instead.
Iterator<ForecastJob>	forecastJobs(SchedulerSession session, DateTimeZone begin, DateTimeZone end, List<Long> jobUniqueIds)	Deprecated. this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use JobForecaster.forecastJobs(SchedulerSession, DateTimeZone, DateTimeZone, List) instead.

Method Detail

forecast

@Deprecated
Iterator<ForecastJob> forecast(SchedulerSession session,
                               DateTimeZone at)
                        throws SchedulerAPIException

Deprecated.

this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use JobForecaster.forecast(SchedulerSession, DateTimeZone) instead.

Create forecast jobs for all active job groups at the specified date.

Parameters:

session - in which to forecast.

at - is the date and time to forecast.

Returns:

iterator with ForecastJobs

Throws:

SchedulerAPIException - if errors are encountered while computing the ForecastJobs.

forecastJobs

@Deprecated
Iterator<ForecastJob> forecastJobs(SchedulerSession session,
                                   DateTimeZone begin,
                                   DateTimeZone end,
                                   List<Long> jobUniqueIds)
                            throws SchedulerAPIException

Deprecated.

this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use JobForecaster.forecastJobs(SchedulerSession, DateTimeZone, DateTimeZone, List) instead.

Create forecast jobs for all active job groups at the specified date range. If jobUniqueIds is null, all jobs in the system will be forecast. Note that forecasts cannot be persisted.

Parameters:

session - in which to forecast.

begin - of the forecast period; an empty list will be returned if not specified.

end - of the forecast period; an empty list will be returned if not specified.

jobUniqueIds - is an optional list of Long or UniqueIdObjects, containing the uniqueIds for the jobs to forecast.

Returns:

iterator with ForecastJobs.

Throws:

SchedulerAPIException - if errors are encountered while computing the ForecastJobs.