abstract

type Action struct {
	Parameters  []Parameter `yaml:"parameters"`
	Name        string      `yaml:"name"`
	Command     string      `yaml:"command"`
	Description string      `yaml:"description"`
	Usage       string      `yaml:"usage"`
}

type ActionImpl struct {
	Action
	InProgress bool
	Success    bool
	Message    string
	Parser     ArgumentParser
	Executor   Command
}

type ActionOps interface {
	/*
	*	Init method
	* Initialise Action to work
	 */
	Init() bool
	/*
	*	Reset method
	* Reset Action for next work
	 */
	Reset() bool
	/*
	*	Execute method
	* Execute Action accordingly to parameters
	* Return execution start/complete status
	 */
	Execute(chan string) bool
	/*
	*	IsInProgress method
	* Return execution progress state
	 */
	IsInProgress() bool
	/*
	*	GetCommand method
	* Return command name
	 */
	GetCommand() string
	/*
	*	GetName method
	* Return command descriptive name
	 */
	GetName() string
	/*
	*	GetUsage method
	* Return command usage sample
	 */
	GetUsage() string
	/*
	*	AcquireValues method
	* Return flag if parameters are satisfied
	 */
	AcquireValues() bool
	/*
	*	GetExitCode method
	* Return execution exit code (0 - ok)
	 */
	GetExitCode() int
	/*
	*	GetLastMessage method
	* Return operation message or error message
	 */
	GetLastMessage() string
	/*
	*	SetArgumentParser method
	* Set Specific Action argument parser
	 */
	SetArgumentParser(ArgumentParser)
	/*
	*	SetArgumentParser method
	* Set Specific Action argument parser
	 */
	SetExecutor(Command)
}

type ActionRegistry struct {
	Actions []ActionOps
}

type ArgumentParser interface {
	Validate() bool
	Parse() []interface{}
}

type Command interface {
	Execute(*ActionImpl, []interface{}, chan string) bool
}

type Parameter struct {
	Name        string `yaml:"name"`
	Description string `yaml:"description"`
	Mandatory   bool   `yaml:"mandatory"`
	HasValue    bool   `yaml:"hasvalue"`
	SampleValue string `yaml:"sample"`
}

type Settings struct {
	DebugDisabled bool `yaml:"noDebug"`
}