pip_services3_commons.commands.ICommandable module

pip_services3_commons.commands.ICommandable

Interface for commandable components

copyright: Conceptual Vision Consulting LLC 2018-2019, see AUTHORS for more details.
license: MIT, see LICENSE for more details.

class pip_services3_commons.commands.ICommandable.ICommandable

Bases: abc.ABC

An interface for commandable objects, which are part of the command_name design pattern. The commandable object exposes its functonality as commands and events groupped into a CommandSet.

This interface is typically implemented by controllers and is used to auto generate external interfaces.

Example:

class MyDataController(ICommandable, IMyDataController):
    _commandSet = None

    def get_command_set(self):
        if self._commandSet is None:
            _commandSet = MyDataCommandSet(self)
        return self._commandSet

get_command_set() → pip_services3_commons.commands.CommandSet.CommandSet 

Gets a command_name set with all supported commands and events.

Returns: a command_name set with commands and events.