Package dev.le_app.mcss_api_java

Class Scheduler

java.lang.Object

dev.le_app.mcss_api_java.Scheduler

public class Scheduler
extends Object

Scheduler of a server Used to create and manage tasks

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Scheduler(MCSSApi api, String GUID)

Method Summary

Modifier and Type	Method	Description
Task	createFixedTimeTask(String Name, Boolean Enabled, Boolean repeating, LocalTime time, Job job)	Create a new Fixed Time task
Task	createIntervalTask(String Name, Boolean Enabled, Boolean repeating, int interval, Job job)	Create a new Interval Task
Task	createTimelessTask(String Name, Boolean Enabled, Job job)	Create a new Interval Task
ArrayList<Task>	getTasks()	Get an arraylist of all the tasks
int	getTotalTaskAmount()	Get total task number
int	getTotalTaskAmount(TaskType filter)	Get number of tasks matching filter

Methods inherited from class java.lang.Object

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

Constructor Details

Scheduler

protected Scheduler(MCSSApi api,
 String GUID)

Method Details

getTotalTaskAmount

public int getTotalTaskAmount()
                       throws APIUnauthorizedException,
APINotFoundException,
IOException,
APINoServerAccessException

Get total task number

Returns:

INT of the total task amount

Throws:

APIUnauthorizedException - if the API key is invalid

APINotFoundException - if the server is not found

IOException - if there is an IO error (e.g. server is offline)

APINoServerAccessException - if the API key does not have access to the server

getTotalTaskAmount

public int getTotalTaskAmount(TaskType filter)
                       throws APIUnauthorizedException,
APINotFoundException,
IOException,
APINoServerAccessException

Get number of tasks matching filter

Parameters:

filter - The type of task to filter by

Returns:

INT of the number of tasks matching the filter

Throws:

APIUnauthorizedException - if the API key is invalid

APINotFoundException - if the server is not found

IOException - if there is an IO error (e.g. server is offline)

APINoServerAccessException - if the API key does not have access to the server

getTasks

public ArrayList<Task> getTasks()
                         throws APIUnauthorizedException,
APINotFoundException,
IOException,
APIInvalidTaskDetailsException,
APINoServerAccessException

Get an arraylist of all the tasks

Returns:

ArrayList of all the tasks

Throws:

APIUnauthorizedException - if the API key is invalid/expired

APINotFoundException - if the server is not found

IOException - if there is an IO error (e.g. server is offline)

APIInvalidTaskDetailsException - if the task details are invalid

APINoServerAccessException - if the API key does not have access to the server

createIntervalTask

public Task createIntervalTask(String Name,
 Boolean Enabled,
 Boolean repeating,
 int interval,
 Job job)
                        throws APIInvalidTaskDetailsException,
APIUnauthorizedException,
IOException,
APINotFoundException,
APINoServerAccessException

Create a new Interval Task

Parameters:

Name - Name of the task to create

Enabled - Whether the task should be enabled or not

repeating - Whether the task should repeat or not

interval - The interval between each task

job - The job to run

Returns:

The created task

Throws:

APIInvalidTaskDetailsException - if the task details are invalid

APIUnauthorizedException - if the API key is invalid/expired

IOException - if there is an IO error (e.g. server is offline)

APINotFoundException - if the server is not found

APINoServerAccessException - if the API key does not have access to the server

createFixedTimeTask

public Task createFixedTimeTask(String Name,
 Boolean Enabled,
 Boolean repeating,
 LocalTime time,
 Job job)
                         throws APIInvalidTaskDetailsException,
APIUnauthorizedException,
IOException,
APINotFoundException,
APINoServerAccessException

Create a new Fixed Time task

Parameters:

Name - Name of the task to create

Enabled - Whether the task should be enabled or not

repeating - Whether the task should repeat or not

time - The time to run the task

job - The job to run

Returns:

The created task

Throws:

APIInvalidTaskDetailsException - if the task details are invalid

APIUnauthorizedException - if the API key is invalid/expired

IOException - if there is an IO error (e.g. server is offline)

APINotFoundException - if the server is not found

APINoServerAccessException - if the API key does not have access to the server

createTimelessTask

public Task createTimelessTask(String Name,
 Boolean Enabled,
 Job job)
                        throws APIInvalidTaskDetailsException,
APIUnauthorizedException,
IOException,
APINotFoundException,
APINoServerAccessException

Create a new Interval Task

Parameters:

Name - Name of the task to create

Enabled - Whether the task should be enabled or not

job - The job to run

Returns:

The created task

Throws:

APIInvalidTaskDetailsException - if the task details are invalid

APIUnauthorizedException - if the API key is invalid/expired

IOException - if there is an IO error (e.g. server is offline)

APINotFoundException - if the server is not found

APINoServerAccessException - if the API key does not have access to the server