io.continual.flowcontrol.jobapi

Interface FlowControlJobDb

All Known Implementing Classes:

DummyJobDb, ModelJobDb

public interface FlowControlJobDb

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FlowControlJobDb.Builder
static class	FlowControlJobDb.RequestException
static class	FlowControlJobDb.ServiceException

Method Summary

Modifier and Type	Method and Description
FlowControlJobDb.Builder	createJob(FlowControlCallContext fccc)
FlowControlJob	getJob(FlowControlCallContext ctx, String name) Get a flow control job or return null if it does not exist for the calling user.
FlowControlJob	getJobAsAdmin(String name) Get a job (or return null) without checking access rights.
Collection<FlowControlJob>	getJobsFor(FlowControlCallContext fccc)
default boolean	jobExists(FlowControlCallContext ctx, String name) Check if a job exists.
void	removeJob(FlowControlCallContext ctx, String name) Remove the given job
void	storeJob(FlowControlCallContext ctx, String name, FlowControlJob job) Store the give job

Method Detail

createJob

FlowControlJobDb.Builder createJob(FlowControlCallContext fccc)
                            throws FlowControlJobDb.ServiceException

Throws:

FlowControlJobDb.ServiceException

getJobsFor

Collection<FlowControlJob> getJobsFor(FlowControlCallContext fccc)
                               throws FlowControlJobDb.ServiceException

Throws:

FlowControlJobDb.ServiceException

getJob

FlowControlJob getJob(FlowControlCallContext ctx,
                      String name)
               throws FlowControlJobDb.ServiceException,
                      AccessException

Get a flow control job or return null if it does not exist for the calling user.

Parameters:

ctx -

name -

Returns:

a job or null

Throws:

FlowControlJobDb.ServiceException

AccessException

getJobAsAdmin

FlowControlJob getJobAsAdmin(String name)
                      throws FlowControlJobDb.ServiceException

Get a job (or return null) without checking access rights.

Parameters:

name -

Returns:

a job or null

Throws:

FlowControlJobDb.ServiceException

jobExists

default boolean jobExists(FlowControlCallContext ctx,
                          String name)
                   throws FlowControlJobDb.ServiceException

Check if a job exists.

Parameters:

ctx -

name -

Returns:

true if the job exists and the user can read it.

Throws:

FlowControlJobDb.ServiceException

storeJob

void storeJob(FlowControlCallContext ctx,
              String name,
              FlowControlJob job)
       throws FlowControlJobDb.ServiceException,
              AccessException,
              FlowControlJobDb.RequestException

Store the give job

Parameters:

ctx -

name -

job -

Throws:

FlowControlJobDb.ServiceException

AccessException

FlowControlJobDb.RequestException

removeJob

void removeJob(FlowControlCallContext ctx,
               String name)
        throws FlowControlJobDb.ServiceException,
               AccessException,
               FlowControlJobDb.RequestException

Remove the given job

Parameters:

ctx -

name -

Throws:

FlowControlJobDb.ServiceException

AccessException

FlowControlJobDb.RequestException