com.github.mvp4g.sema4g.client.command

Interface SeMa4gCommand

All Known Implementing Classes:

AbstractCommand, AsyncCommand, SyncCommand

public interface SeMa4gCommand

This interface provide all needed methods to interact with the SeMa4g

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SeMa4gCommand.State state of the execution context

Method Summary

Modifier and Type	Method and Description
void	checkCycleDependencies(List<SeMa4gCommand> usedDependencies) Checks if there is a cycle dependencies for this command.
SeMa4gCommand	dependingOn(SeMa4gCommand... dependencies) Definies the SeMa4gCommand (one or more) which have to be finished before this command can be executed.
List<SeMa4gCommand>	getDependencies() Returns the list of SeMa4gCommand for this SeMa4gCommand which have to be (successfully) executed before this command can be started
SeMa4g	getExecutionContext() Returns the SeMa4g for this command.
SeMa4gCommand.State	getState() Returns the current SeMa4gCommand.State
void	reset() this method is called to reset the command
void	run() This method is used by the execution context to start the command
void	setExecutionContext(SeMa4g executionContext) Sets the SeMa4g for this command.
void	setState(SeMa4gCommand.State state) Sets the SeMa4gCommand.State of the command
void	signalError() This command can be called to interrupt the execution and start the error behavior.
void	startCheckCycleDependencies() starts a cycle dependency check

Method Detail

checkCycleDependencies

void checkCycleDependencies(List<SeMa4gCommand> usedDependencies)
                     throws SeMa4gException

Checks if there is a cycle dependencies for this command.

Parameters:

usedDependencies - all dependencies for this command

Throws:

SeMa4gException - when a cycle dependency is detected

dependingOn

SeMa4gCommand dependingOn(SeMa4gCommand... dependencies)
                   throws SeMa4gException

Definies the SeMa4gCommand (one or more) which have to be finished before this command can be executed.

Parameters:

dependencies - list of commands which have to be finished, before this command can be started

Returns:

the inistnace of the command

Throws:

SeMa4gException - when a cycle dependency is detected

getDependencies

List<SeMa4gCommand> getDependencies()

Returns the list of SeMa4gCommand for this SeMa4gCommand which have to be (successfully) executed before this command can be started

Returns:

list of depending commands

getExecutionContext

SeMa4g getExecutionContext()

Returns the SeMa4g for this command.

Returns:

The SeMa4g for this command

setExecutionContext

void setExecutionContext(SeMa4g executionContext)

Sets the SeMa4g for this command.

Parameters:

executionContext - the SeMa4g for this command

getState

SeMa4gCommand.State getState()

Returns the current SeMa4gCommand.State

Returns:

current state of the command

setState

void setState(SeMa4gCommand.State state)

Sets the SeMa4gCommand.State of the command

Parameters:

state - the new state

signalError

void signalError()

This command can be called to interrupt the execution and start the error behavior.

run

void run()

This method is used by the execution context to start the command

startCheckCycleDependencies

void startCheckCycleDependencies()
                          throws SeMa4gException

starts a cycle dependency check

Throws:

SeMa4gException - in case there is a cycle dependency

reset

void reset()

this method is called to reset the command