Package dev.getelements.elements.sdk.dao

Interface ScheduleDao

All Known Implementing Classes:

MongoScheduleDao

public interface ScheduleDao

Provides access to Schedule instances within the database.

Method Summary

Modifier and Type	Method	Description
Schedule	create(Schedule schedule)	Creates a new Schedule in the database.
void	deleteSchedule(String scheduleNameOrId)
Optional<Schedule>	findScheduleByNameOrId(String scheduleNameOrId)	Finds the Schedule with the supplied name or id.
default Schedule	getScheduleByNameOrId(String scheduleNameOrId)	Gets the Schedule with the supplied name or id.
Pagination<Schedule>	getSchedules(int offset, int count)
Pagination<Schedule>	getSchedules(int offset, int count, String search)
Schedule	updateSchedule(Schedule updatedSchedule)	Updates a Schedule with the supplied Schedule.

Method Details

create

Schedule create(Schedule schedule)

Creates a new Schedule in the database.

Parameters:

schedule - the schedule

Returns:

the Schedule as created

findScheduleByNameOrId

Optional<Schedule> findScheduleByNameOrId(String scheduleNameOrId)

Finds the Schedule with the supplied name or id.

Parameters:

scheduleNameOrId - the schedule name and id

Returns:

an Optional<Schedule>

getScheduleByNameOrId

default Schedule getScheduleByNameOrId(String scheduleNameOrId)

Gets the Schedule with the supplied name or id.

Parameters:

scheduleNameOrId -

scheduleNameOrId - the schedule name and id

Returns:

the Schedule, never null

Throws:

ScheduleNotFoundException

getSchedules

Pagination<Schedule> getSchedules(int offset,
 int count)

getSchedules

Pagination<Schedule> getSchedules(int offset,
 int count,
 String search)

updateSchedule

Schedule updateSchedule(Schedule updatedSchedule)

Updates a Schedule with the supplied Schedule.

Parameters:

updatedSchedule - the updated Schedule

Returns:

the Schedule as updated

deleteSchedule

void deleteSchedule(String scheduleNameOrId)