Package io.jenkins.plugins.view.calendar.service

Class CalendarEventService

java.lang.Object

io.jenkins.plugins.view.calendar.service.CalendarEventService

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class CalendarEventService
extends Object

Constructor Summary

Constructors

Constructor	Description
CalendarEventService(Moment now, CronJobService cronJobService)

Method Summary

Modifier and Type	Method	Description
List<CalendarEvent>	getCalendarEvents(List<? extends Job> jobs, MomentRange inclusionRange, CalendarView.CalendarViewEventsType eventsType)	Collects all the events that overlap the given range.
List<StartedCalendarEvent>	getFinishedEvents(List<? extends Job> jobs, MomentRange range, CalendarView.CalendarViewEventsType eventsType)
List<StartedCalendarEvent>	getLastEvents(CalendarEvent event, int numberOfEvents)
StartedCalendarEvent	getNextEvent(StartedCalendarEvent event)
ScheduledCalendarEvent	getNextScheduledEvent(CalendarEvent event, CalendarView.CalendarViewEventsType eventsType)
StartedCalendarEvent	getPreviousEvent(StartedCalendarEvent event)
List<StartedCalendarEvent>	getRunningEvents(List<? extends Job> jobs, MomentRange range, CalendarView.CalendarViewEventsType eventsType)
List<ScheduledCalendarEvent>	getScheduledEvents(List<? extends Job> jobs, io.jenkins.plugins.view.calendar.service.CalendarEventService.ScheduledEventCollector collector, CalendarView.CalendarViewEventsType eventsType)
List<ScheduledCalendarEvent>	getScheduledEventsBackward(List<? extends Job> jobs, MomentRange searchRange, MomentRange inclusionRange, CalendarView.CalendarViewEventsType eventsType)
List<ScheduledCalendarEvent>	getScheduledEventsForward(List<? extends Job> jobs, MomentRange searchRange, MomentRange inclusionRange, CalendarView.CalendarViewEventsType eventsType)
List<StartedCalendarEvent>	getStartedEvents(List<? extends Job> jobs, MomentRange range, CalendarEventState state, CalendarView.CalendarViewEventsType eventsType)

Methods inherited from class java.lang.Object

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

Constructor Details

CalendarEventService

public CalendarEventService(Moment now,
 CronJobService cronJobService)

Method Details

getCalendarEvents

public List<CalendarEvent> getCalendarEvents(List<? extends Job> jobs,
 MomentRange inclusionRange,
 CalendarView.CalendarViewEventsType eventsType)

Collects all the events that overlap the given range. Includes events that start before the range, but last into the range; also includes events that end after the range, but start within the range.

Parameters:

jobs - The jobs from which to collect all CalendarEvents

inclusionRange - The range for which CalendarEvents should be returned

eventsType - The type of event that should be filtered on

Returns:

List of events that overlap the range

getScheduledEventsForward

public List<ScheduledCalendarEvent> getScheduledEventsForward(List<? extends Job> jobs,
 MomentRange searchRange,
 MomentRange inclusionRange,
 CalendarView.CalendarViewEventsType eventsType)

getScheduledEventsBackward

public List<ScheduledCalendarEvent> getScheduledEventsBackward(List<? extends Job> jobs,
 MomentRange searchRange,
 MomentRange inclusionRange,
 CalendarView.CalendarViewEventsType eventsType)

getScheduledEvents

public List<ScheduledCalendarEvent> getScheduledEvents(List<? extends Job> jobs,
 io.jenkins.plugins.view.calendar.service.CalendarEventService.ScheduledEventCollector collector,
 CalendarView.CalendarViewEventsType eventsType)

getFinishedEvents

public List<StartedCalendarEvent> getFinishedEvents(List<? extends Job> jobs,
 MomentRange range,
 CalendarView.CalendarViewEventsType eventsType)

getRunningEvents

public List<StartedCalendarEvent> getRunningEvents(List<? extends Job> jobs,
 MomentRange range,
 CalendarView.CalendarViewEventsType eventsType)

getStartedEvents

public List<StartedCalendarEvent> getStartedEvents(List<? extends Job> jobs,
 MomentRange range,
 CalendarEventState state,
 CalendarView.CalendarViewEventsType eventsType)

getLastEvents

public List<StartedCalendarEvent> getLastEvents(CalendarEvent event,
 int numberOfEvents)

getPreviousEvent

public StartedCalendarEvent getPreviousEvent(StartedCalendarEvent event)

getNextEvent

public StartedCalendarEvent getNextEvent(StartedCalendarEvent event)

getNextScheduledEvent

public ScheduledCalendarEvent getNextScheduledEvent(CalendarEvent event,
 CalendarView.CalendarViewEventsType eventsType)