Package com.apama.dashboard.command

Interface ICommandLibrary

  • public interface ICommandLibrary
    ICommandLibrary is the interface a Dashboard Studio custom command library must implement. A command library provides the ability to extend Dashboard Studio through the addition of custom commands. A custom command library can implement multiple commands.

    • Method Detail

      • getCommandDescriptors

        java.util.List<ICommandDescriptor> getCommandDescriptors()
        Get the list of CommandDescriptors defining the commands implemented by the library.
        Returns:
        List of CommandDescriptors.

      • invokeCommand

        boolean invokeCommand​(java.lang.String command,
                      java.lang.Object arguments)
        Invoke a command. Called at runtime when a user action triggers the execution of a custom command.
        Parameters:
        command - Name of command to invoke.
        arguments - Arguments to command.
        Returns:
        true if command handled; false otherwise.