Package dev.getelements.elements.sdk.dao

Interface ScheduleEventDao

All Known Implementing Classes:

MongoScheduleEventDao

public interface ScheduleEventDao

Manges ScheduleEvent instances within the database.

Method Summary

Modifier and Type	Method	Description
ScheduleEvent	createScheduleEvent(ScheduleEvent scheduleEvent)	Creates a new ScheduleEvent.
void	deleteScheduleEvent(String scheduleNameOrId, String scheduleEventId)	Deletes a specific schedule event.
void	deleteScheduleEvents(String scheduleNameOrId)	Deletes all events associated with the supplied schedule id.
Optional<ScheduleEvent>	findScheduleEventById(String scheduleNameOrId, String scheduleEventId)	Finds a Schedule by name or ID.
default List<ScheduleEvent>	getAllScheduleEvents(String scheduleNameOrId)	Gets all ScheduleEvent instances for the supplied Schedule
default List<ScheduleEvent>	getAllScheduleEvents(String scheduleNameOrId, boolean includeExpired, boolean includeFuture)	Gets all ScheduleEvent instances for the supplied Schedule
List<ScheduleEvent>	getAllScheduleEvents(String scheduleNameOrId, boolean includeExpired, boolean includeFuture, long reference)	Gets all ScheduleEvent instances for the supplied Schedule
default ScheduleEvent	getScheduleEventById(String scheduleNameOrId, String scheduleEventId)	Gets the ScheduleEvent with the id and schedule id.
Pagination<ScheduleEvent>	getScheduleEvents(String scheduleNameOrId, int offset, int count)	Gets a Pagination<ScheduleEvent> of ScheduleEvent instances for the supplied Schedule
Pagination<ScheduleEvent>	getScheduleEvents(String scheduleNameOrId, int offset, int count, String search)	Gets a Pagination<ScheduleEvent> of ScheduleEvent instances for the supplied Schedule
ScheduleEvent	updateScheduleEvent(ScheduleEvent scheduleEvent)	Updates the ScheduleEvent.

Method Details

createScheduleEvent

ScheduleEvent createScheduleEvent(ScheduleEvent scheduleEvent)

Creates a new ScheduleEvent.

Parameters:

scheduleEvent - the ScheduleEvent to create

Returns:

the object as written to the database

updateScheduleEvent

ScheduleEvent updateScheduleEvent(ScheduleEvent scheduleEvent)

Updates the ScheduleEvent.

Parameters:

scheduleEvent - the ScheduleEvent to update

Returns:

the object as written to the database

getScheduleEvents

Pagination<ScheduleEvent> getScheduleEvents(String scheduleNameOrId,
 int offset,
 int count)

Gets a Pagination<ScheduleEvent> of ScheduleEvent instances for the supplied Schedule

Parameters:

scheduleNameOrId - the name or id of the Schedule

Returns:

a Pagination<ScheduleEvent> of schedule events.

getScheduleEvents

Pagination<ScheduleEvent> getScheduleEvents(String scheduleNameOrId,
 int offset,
 int count,
 String search)

Gets a Pagination<ScheduleEvent> of ScheduleEvent instances for the supplied Schedule

Parameters:

scheduleNameOrId - the name or id of the Schedule

search - the search query

Returns:

a Pagination<ScheduleEvent> of schedule events.

getAllScheduleEvents

default List<ScheduleEvent> getAllScheduleEvents(String scheduleNameOrId)

Gets all ScheduleEvent instances for the supplied Schedule

Parameters:

scheduleNameOrId - the name or id of the ScheduleEvent

Returns:

a List<ScheduleEvent> of schedule events.

getAllScheduleEvents

default List<ScheduleEvent> getAllScheduleEvents(String scheduleNameOrId,
 boolean includeExpired,
 boolean includeFuture)

Gets all ScheduleEvent instances for the supplied Schedule

Parameters:

scheduleNameOrId - the name or id of the ScheduleEvent

includeExpired - true to include events that have expired

includeFuture - true to include events that have yet to be scheduled

Returns:

a List<ScheduleEvent> of schedule events.

getAllScheduleEvents

List<ScheduleEvent> getAllScheduleEvents(String scheduleNameOrId,
 boolean includeExpired,
 boolean includeFuture,
 long reference)

Gets all ScheduleEvent instances for the supplied Schedule

Parameters:

scheduleNameOrId - the name or id of the ScheduleEvent

Returns:

a List<ScheduleEvent> of schedule events.

findScheduleEventById

Optional<ScheduleEvent> findScheduleEventById(String scheduleNameOrId,
 String scheduleEventId)

Finds a Schedule by name or ID.

Parameters:

scheduleNameOrId - the schedule name or id

scheduleEventId - the schedule event id

Returns:

Optional<ScheduleEvent>

getScheduleEventById

default ScheduleEvent getScheduleEventById(String scheduleNameOrId,
 String scheduleEventId)

Gets the ScheduleEvent with the id and schedule id.

Parameters:

scheduleNameOrId - the schedule name or id

scheduleEventId - the schedule event id

Returns:

a ScheduleEvent, never null

deleteScheduleEvents

void deleteScheduleEvents(String scheduleNameOrId)

Deletes all events associated with the supplied schedule id.

Parameters:

scheduleNameOrId - the schedule name or id

deleteScheduleEvent

void deleteScheduleEvent(String scheduleNameOrId,
 String scheduleEventId)

Deletes a specific schedule event.

Parameters:

scheduleNameOrId - the schedule name or id

scheduleEventId - the schedule event id