com.sitewhere.spi.scheduling

Interface IScheduleManagement

All Superinterfaces:

ILifecycleComponent, ITenantLifecycleComponent

public interface IScheduleManagement
extends ITenantLifecycleComponent

Management interface for persistent scheduling implementations.

Method Summary

Modifier and Type	Method and Description
ISchedule	createSchedule(IScheduleCreateRequest request) Create a new schedule.
IScheduledJob	createScheduledJob(IScheduledJobCreateRequest request) Create a new scheduled job.
ISchedule	deleteSchedule(java.lang.String token, boolean force) Delete an existing schedule.
IScheduledJob	deleteScheduledJob(java.lang.String token, boolean force) Delete an existing scheduled job.
ISchedule	getScheduleByToken(java.lang.String token) Get a schedule by unique token.
IScheduledJob	getScheduledJobByToken(java.lang.String token) Get a scheduled job by unique token.
ISearchResults<IScheduledJob>	listScheduledJobs(ISearchCriteria criteria) List scheduled jobs that match the given criteria.
ISearchResults<ISchedule>	listSchedules(ISearchCriteria criteria) List schedules that match the given criteria.
ISchedule	updateSchedule(java.lang.String token, IScheduleCreateRequest request) Update an existing schedule.
IScheduledJob	updateScheduledJob(java.lang.String token, IScheduledJobCreateRequest request) Update an existing scheduled job.

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ITenantLifecycleComponent

getTenant, setTenant

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent

canPause, findComponentsOfType, getComponentId, getComponentName, getComponentType, getCreatedDate, getLifecycleComponents, getLifecycleError, getLifecycleStatus, getLogger, initialize, initializeNestedComponent, lifecycleInitialize, lifecyclePause, lifecycleStart, lifecycleStop, lifecycleStop, logState, pause, start, startNestedComponent, stop, stop

Method Detail

createSchedule

ISchedule createSchedule(IScheduleCreateRequest request)
                  throws SiteWhereException

Create a new schedule.

Parameters:

request -

Returns:

Throws:

SiteWhereException

updateSchedule

ISchedule updateSchedule(java.lang.String token,
                         IScheduleCreateRequest request)
                  throws SiteWhereException

Update an existing schedule.

Parameters:

token -

request -

Returns:

Throws:

SiteWhereException

getScheduleByToken

ISchedule getScheduleByToken(java.lang.String token)
                      throws SiteWhereException

Get a schedule by unique token.

Parameters:

token -

Returns:

Throws:

SiteWhereException

listSchedules

ISearchResults<ISchedule> listSchedules(ISearchCriteria criteria)
                                 throws SiteWhereException

List schedules that match the given criteria.

Parameters:

criteria -

Returns:

Throws:

SiteWhereException

deleteSchedule

ISchedule deleteSchedule(java.lang.String token,
                         boolean force)
                  throws SiteWhereException

Delete an existing schedule.

Parameters:

token -

force -

Returns:

Throws:

SiteWhereException

createScheduledJob

IScheduledJob createScheduledJob(IScheduledJobCreateRequest request)
                          throws SiteWhereException

Create a new scheduled job.

Parameters:

request -

Returns:

Throws:

SiteWhereException

updateScheduledJob

IScheduledJob updateScheduledJob(java.lang.String token,
                                 IScheduledJobCreateRequest request)
                          throws SiteWhereException

Update an existing scheduled job.

Parameters:

token -

request -

Returns:

Throws:

SiteWhereException

getScheduledJobByToken

IScheduledJob getScheduledJobByToken(java.lang.String token)
                              throws SiteWhereException

Get a scheduled job by unique token.

Parameters:

token -

Returns:

Throws:

SiteWhereException

listScheduledJobs

ISearchResults<IScheduledJob> listScheduledJobs(ISearchCriteria criteria)
                                         throws SiteWhereException

List scheduled jobs that match the given criteria.

Parameters:

criteria -

Returns:

Throws:

SiteWhereException

deleteScheduledJob

IScheduledJob deleteScheduledJob(java.lang.String token,
                                 boolean force)
                          throws SiteWhereException

Delete an existing scheduled job.

Parameters:

token -

force -

Returns:

Throws:

SiteWhereException