Package dev.le_app.mcss_api_java

Class Task

java.lang.Object

dev.le_app.mcss_api_java.Task

public class Task
extends Object

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Task(MCSSApi api, String GUID, String taskID, String taskName, boolean enabled)

Method Summary

Modifier and Type	Method	Description
void	changeName(String newName)	Change the task name
void	deleteTask()	Delete the task from the API
long	getInterval()	Get the interval information for the Task.
Job	getJob()
PlayerRequirement	getPlayerRequirement()
String	getTaskID()
TaskJobType	getTaskJobType()
String	getTaskName()
TaskType	getTaskType()
LocalTime	getTime()	Get the timing information for the Task.
boolean	isDeleted()
boolean	isEnabled()
boolean	isRepeating()	Check if the task repeats at the set interval/fixed time
void	runTask()	Manually run the task
void	setDisabled()	Disables the task
void	setEnabled()	Enables the task
void	setInterval(long newInterval)	Change the interval of an Interval task
void	setPlayerRequirement(PlayerRequirement playerRequirement)
void	setRepeating(boolean repeat)	Set the task to repeat
void	setTime(LocalTime newTime)

Methods inherited from class java.lang.Object

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

Constructor Details

Task

protected Task(MCSSApi api,
 String GUID,
 String taskID,
 String taskName,
 boolean enabled)
        throws APIUnauthorizedException,
IOException,
APINotFoundException,
APIInvalidTaskDetailsException,
APINoServerAccessException

Throws:

APIUnauthorizedException

IOException

APINotFoundException

APIInvalidTaskDetailsException

APINoServerAccessException

Method Details

getTaskID

public String getTaskID()

Returns:

the Task ID

getTaskName

public String getTaskName()

Returns:

the Task Name

getTaskType

public TaskType getTaskType()

Returns:

the Task Type

getTaskJobType

public TaskJobType getTaskJobType()

Returns:

the Task Job Type

getPlayerRequirement

public PlayerRequirement getPlayerRequirement()

Returns:

the Task Player Requirement

isEnabled

public boolean isEnabled()

Returns:

the enabled status of the Task

isRepeating

public boolean isRepeating()
                    throws APIUnauthorizedException,
APINotFoundException,
APIInvalidTaskDetailsException,
IOException,
APINoServerAccessException

Check if the task repeats at the set interval/fixed time

Returns:

true if the task repeats at the set interval/fixed time

Throws:

APIUnauthorizedException - if the API key is invalid

APINotFoundException - if the server or task is not found

APIInvalidTaskDetailsException - if the task has no timing information

IOException - if there is an error connecting to the server

APINoServerAccessException

getTime

public LocalTime getTime()
                  throws IOException,
APIUnauthorizedException,
APINotFoundException,
APIInvalidTaskDetailsException,
APINoServerAccessException

Get the timing information for the Task.

Returns:

the timing information for the Task

Throws:

IOException - if there is an error connecting to the server

APIUnauthorizedException - if the API key is invalid

APINotFoundException - if the server or task is not found

APIInvalidTaskDetailsException - if the task has no timing information, or if the task has an invalid timing information

APINoServerAccessException

getInterval

public long getInterval()
                 throws APIUnauthorizedException,
APINotFoundException,
APIInvalidTaskDetailsException,
IOException,
APINoServerAccessException

Get the interval information for the Task.

Returns:

Long int of the interval in seconds

Throws:

APIUnauthorizedException - if the API key is invalid

APINotFoundException - if the server or task is not found

APIInvalidTaskDetailsException - if the task has no interval information, or if the task has an invalid interval information

IOException - if there is an error connecting to the server

APINoServerAccessException

getJob

public Job getJob()
           throws APINotFoundException

Throws:

APINotFoundException

isDeleted

public boolean isDeleted()

Returns:

true if the task has been deleted from the API

setEnabled

public void setEnabled()
                throws IOException,
APINotFoundException,
APIUnauthorizedException,
APIInvalidTaskDetailsException,
APINoServerAccessException

Enables the task

Throws:

IOException - if there is an error connecting to the server

APINotFoundException - if the server returns a 404 response code

APIUnauthorizedException - if the server returns a 401 response code

APIInvalidTaskDetailsException - if the server returns a 409 response code

APINoServerAccessException

setDisabled

public void setDisabled()
                 throws IOException,
APINotFoundException,
APIUnauthorizedException,
APIInvalidTaskDetailsException,
APINoServerAccessException

Disables the task

Throws:

IOException - if there is an error connecting to the server

APINotFoundException - if the server returns a 404 response code

APIUnauthorizedException - if the server returns a 401 response code

APIInvalidTaskDetailsException - if the server returns a 409 response code

APINoServerAccessException

setInterval

public void setInterval(long newInterval)
                 throws APIUnauthorizedException,
APINotFoundException,
APIInvalidTaskDetailsException,
IOException,
APINoServerAccessException

Change the interval of an Interval task

Throws:

APIUnauthorizedException - if the API key is invalid

APINotFoundException - if the server or task is not found

APIInvalidTaskDetailsException - if the task has no interval information, or if the task has an invalid interval information

IOException - if there is an error connecting to the server

APINoServerAccessException

setTime

public void setTime(LocalTime newTime)
             throws APIUnauthorizedException,
APINotFoundException,
APIInvalidTaskDetailsException,
IOException,
APINoServerAccessException

Throws:

APIUnauthorizedException

APINotFoundException

APIInvalidTaskDetailsException

IOException

APINoServerAccessException

runTask

public void runTask()
             throws IOException,
APINotFoundException,
APIUnauthorizedException,
APIInvalidTaskDetailsException,
APINoServerAccessException

Manually run the task

Throws:

IOException - if there is an error connecting to the server

APINotFoundException - if the server returns a 404 response code

APIUnauthorizedException - if the server returns a 401 response code

APIInvalidTaskDetailsException

APINoServerAccessException

setRepeating

public void setRepeating(boolean repeat)
                  throws APIUnauthorizedException,
APINotFoundException,
APIInvalidTaskDetailsException,
IOException,
APINoServerAccessException

Set the task to repeat

Parameters:

repeat - boolean of the new repeat value, true or false

Throws:

APIUnauthorizedException - if the API key is invalid

APINotFoundException - if the server or task is not found

APIInvalidTaskDetailsException - if the task has no repeat information, or if the task has an invalid repeat information

IOException - if there is an error connecting to the server

APINoServerAccessException

changeName

public void changeName(String newName)
                throws APIInvalidTaskDetailsException,
APIUnauthorizedException,
APINotFoundException,
IOException,
APINoServerAccessException

Change the task name

Parameters:

newName - the new name for the task

Throws:

APIInvalidTaskDetailsException - if the server returns a 409 response code

APIUnauthorizedException - if the server returns a 401 response code

APINotFoundException - if the server returns a 404 response code

IOException - if there is an error connecting to the server

APINoServerAccessException

setPlayerRequirement

public void setPlayerRequirement(PlayerRequirement playerRequirement)
                          throws APIUnauthorizedException,
APINotFoundException,
APINoServerAccessException,
APIInvalidTaskDetailsException,
IOException

Throws:

APIUnauthorizedException

APINotFoundException

APINoServerAccessException

APIInvalidTaskDetailsException

IOException

deleteTask

public void deleteTask()
                throws IOException,
APINotFoundException,
APIUnauthorizedException,
APINoServerAccessException

Delete the task from the API

Throws:

IOException - if there is an error connecting to the server

APINotFoundException - if the server returns a 404 response code

APIUnauthorizedException - if the server returns a 401 response code

APINoServerAccessException