Package dev.le_app.mcss_api_java

Class Job

java.lang.Object

dev.le_app.mcss_api_java.Job

Direct Known Subclasses:

BackupJob, RunCommandsJob, ServerActionJob

public abstract class Job
extends Object

Represents a job.

Constructor Summary

Constructors

Constructor	Description
Job()

Method Summary

Modifier and Type	Method	Description
abstract ServerAction	getAction()	Get the action of the task.
abstract String	getBackupGUID()	Get the Backup ID of the backup executed by the task
abstract ArrayList<String>	getCommands()	Get the commands of the task.
abstract Job	setAction(ServerAction action)	Set the new action to execute
abstract Job	setBackupGUID(String backupGUID)	Set the new backup to execute
abstract Job	setCommands(String... commands)	Set the new commands to execute

Methods inherited from class java.lang.Object

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

Constructor Details

Job

public Job()

Method Details

getAction

public abstract ServerAction getAction()
                                throws APIUnauthorizedException,
APINotFoundException,
IOException,
APIInvalidTaskDetailsException

Get the action of the task.

Returns:

The action of the task.

Throws:

APIUnauthorizedException - If the API key is not valid.

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.

getCommands

public abstract ArrayList<String> getCommands()
                                       throws APIUnauthorizedException,
APINotFoundException,
IOException,
APIInvalidTaskDetailsException

Get the commands of the task.

Returns:

The commands of the task.

Throws:

APIUnauthorizedException - If the API key is not valid.

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.

getBackupGUID

public abstract String getBackupGUID()
                              throws APIUnauthorizedException,
APINotFoundException,
IOException

Get the Backup ID of the backup executed by the task

Returns:

The Backup ID of the backup executed by the task

Throws:

APIUnauthorizedException - If the API key is not valid.

APINotFoundException - If the server is not found.

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

setAction

public abstract Job setAction(ServerAction action)
                       throws APIUnauthorizedException,
APINotFoundException,
APIInvalidTaskDetailsException,
IOException

Set the new action to execute

Parameters:

action - The new action to execute

Returns:

this.Job (used for concatenating)

Throws:

APIUnauthorizedException - If the API key is not valid.

APINotFoundException - If the server is not found.

APIInvalidTaskDetailsException - If the task details are invalid.

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

setCommands

public abstract Job setCommands(String... commands)
                         throws APIUnauthorizedException,
APINotFoundException,
APIInvalidTaskDetailsException,
IOException

Set the new commands to execute

Parameters:

commands - The new commands to execute

Returns:

this.Job (used for concatenating)

Throws:

APIUnauthorizedException - If the API key is not valid.

APINotFoundException - If the server is not found.

APIInvalidTaskDetailsException - If the task details are invalid.

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

setBackupGUID

public abstract Job setBackupGUID(String backupGUID)
                           throws APIUnauthorizedException,
APINotFoundException,
IOException,
APIInvalidTaskDetailsException

Set the new backup to execute

Parameters:

backupGUID - The new backup to execute

Returns:

this.Job (used for concatenating)

Throws:

APIUnauthorizedException - If the API key is not valid.

APINotFoundException - If the server is not found.

APIInvalidTaskDetailsException - If the task details are invalid.

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