SEE ALSO

NAME

org::puremvc::perl5::patterns::command::MacroCommand

inherits:

org::puremvc::perl5::patterns::observer::Notifier

A Base pureMVC Command concept implementation that executes other commands.

SYNOPSIS

  package com::me::myapp::commands::AMacroCommand;

  use strict; use warnings;

  use org::puremvc::perl5::patterns::command::MacroCommand;
  our @ISA = qw( org::puremvc::perl5::patterns::command::MacroCommand );

  use com::me::myapp::commands::AFirstSubCommand;
  use com::me::myapp::commands::ASecondSubCommand;

  sub initializeMacroCommand {
    my $self = shift;
  
    $self->addSubCommand( "com::me::myapp::commands::AFirstSubCommand" );
    $self->addSubCommand( "com::me::myapp::commands::ASecondSubCommand" );
  
  }

  #**********************
  #**********************
  1;

DESCRIPTION

A MacroCommand maintains a list of Commands class names called SubCommands.

When execute is called, the MacroCommand instantiates and calls execute on each of its SubCommands in the order they where registered.

Each SubCommand will be passed a reference to the original notification that was passed to the MacroCommand's execute method.

Unlike SimpleCommand, your subclass should not override execute, but instead, should override the initializeMacroCommand method, calling addSubCommand once for each SubCommand to be executed.

A SubCommand can be a SimpleCommand or another MacroCommand.

INTERFACE

Methods

initializeMacroCommand

sub initializeMacroCommand();

Initialize the MacroCommand.

In your subclass, override this method to register the MacroCommand's SubCommands like this:

  $self->addSubCommand( "com::me::myapp::commands::ASubCommand" );

addSubCommand

sub addSubCommand( $command_class_ref );

The SubCommands will be called in First In/First Out (FIFO) order.

Parameters

$command_class_ref - String

Name of the SubCommand to register to the MacroCommand's list.

execute

sub execute( $notification );

Execute the MacroCommand's SubCommands.