Actions
The actions namespace contains interfaces that describe objects which can perform certain actions. It's basically semantic sugar for human convenience. The following interfaces are declared:
InitializableInterface
-- describes an object that implements aninitialize
methodSetupableInterface
-- describes an object that implements asetup
methodOutputtableInterface
-- describes an object that implements anoutput
methodRunnableInterface
-- describes an object that implements arun
methodResettableInterface
-- describes an object that implements areset
method
The result of the aforementioned methods is either null
on success, or a specific Exception
object describing the issue on failure.
Semantically, an initializable object should be initialized before calling any other methods on it. If it's also setupable, then the setup should only be run on successful initialization.
There is nothing more to the action interfaces. You are obviously free to misuse them in your own plugins, but the framework will adhere to all the hints and conventions laid out in this document.
Last updated