Module io.github.tonywasher.joceanus.tethys.api

Package io.github.tonywasher.joceanus.tethys.api.thread

Interface TethysUIThreadStatusReport

All Known Subinterfaces:

TethysUIThreadManager

All Known Implementing Classes:

TethysUICoreThreadManager

public interface TethysUIThreadStatusReport

Report status.

Method Summary

Modifier and Type	Method	Description
void	checkForCancellation()	Is the task cancelled?
OceanusProfile	getActiveTask()	Obtain the active task.
Object	getThreadData()	Obtain the thread data.
default void	initTask(OceanusBundleId pTask)	Initialise Task.
void	initTask(String pTask)	Initialise Task.
void	setCompletion()	Set Completion.
default void	setNewStage(OceanusBundleId pStage)	Set new stage.
void	setNewStage(String pStage)	Set new stage.
void	setNextStep()	Set next step.
void	setNextStep(String pStep)	Set next step.
void	setNumStages(int pNumStages)	Set number of stages.
void	setNumSteps(int pNumSteps)	Set number of steps.
void	setStepsDone(int pSteps)	Set steps done.
void	throwCancelException()	Throw cancellation exception.

Method Details

getThreadData

Object getThreadData()

Obtain the thread data.

Returns:

the threadData

initTask

default void initTask(OceanusBundleId pTask)
               throws OceanusException

Initialise Task.

Parameters:

pTask - the task

Throws:

OceanusException - on cancellation

initTask

void initTask(String pTask)
       throws OceanusException

Initialise Task.

Parameters:

pTask - the task

Throws:

OceanusException - on cancellation

setNumStages

void setNumStages(int pNumStages)
           throws OceanusException

Set number of stages.

Parameters:

pNumStages - the number of stages

Throws:

OceanusException - on cancellation

setNewStage

void setNewStage(String pStage)
          throws OceanusException

Set new stage.

Parameters:

pStage - the new stage

Throws:

OceanusException - on cancellation

setNewStage

default void setNewStage(OceanusBundleId pStage)
                  throws OceanusException

Set new stage.

Parameters:

pStage - the new stage

Throws:

OceanusException - on cancellation

setNumSteps

void setNumSteps(int pNumSteps)
          throws OceanusException

Set number of steps.

Parameters:

pNumSteps - the number of steps

Throws:

OceanusException - on cancellation

setStepsDone

void setStepsDone(int pSteps)
           throws OceanusException

Set steps done.

Parameters:

pSteps - the number of steps done

Throws:

OceanusException - on cancellation

setNextStep

void setNextStep()
          throws OceanusException

Set next step.

Throws:

OceanusException - on cancellation

setNextStep

void setNextStep(String pStep)
          throws OceanusException

Set next step.

Parameters:

pStep - the step to set

Throws:

OceanusException - on cancellation

setCompletion

void setCompletion()
            throws OceanusException

Set Completion.

Throws:

OceanusException - on cancellation

checkForCancellation

void checkForCancellation()
                   throws OceanusException

Is the task cancelled?

Throws:

OceanusException - on cancellation

throwCancelException

void throwCancelException()
                   throws OceanusException

Throw cancellation exception.

Throws:

OceanusException - on error

getActiveTask

OceanusProfile getActiveTask()

Obtain the active task.

Returns:

the active task