View Javadoc

    1   /*
    2    *
    3    *   Copyright 2005 The Apache Software Foundation.
    4    *
    5    *  Licensed under the Apache License, Version 2.0 (the "License");
    6    *  you may not use this file except in compliance with the License.
    7    *  You may obtain a copy of the License at
    8    *
    9    *      http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   *  Unless required by applicable law or agreed to in writing, software
    12   *  distributed under the License is distributed on an "AS IS" BASIS,
    13   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   *  See the License for the specific language governing permissions and
    15   *  limitations under the License.
    16   *
    17   */
    18  package org.apache.commons.scxml;
    19
    20  import java.util.List;
    21  import java.util.Map;
    22
    23  /***
    24   * The event controller interface used to send messages containing
    25   * events or other information directly to another SCXML Interpreter,
    26   * other external systems using an Event I/O Processor or to raise
    27   * events in the current SCXML session.
    28   *
    29   */
    30  public interface EventDispatcher {
    31
    32      /***
    33       * Cancel the specified send message.
    34       *
    35       * @param sendId The ID of the send message to cancel
    36       */
    37      void cancel(String sendId);
    38
    39      /***
    40       * Send this message to the target.
    41       *
    42       * @param sendId The ID of the send message
    43       * @param target An expression returning the target location of the event
    44       * @param targetType The type of the Event I/O Processor that the event
    45       *  should be dispatched to
    46       * @param event The type of event being generated.
    47       * @param params A list of zero or more whitespace separated variable
    48       *  names to be included with the event.
    49       * @param hints The data containing information which may be
    50       *  used by the implementing platform to configure the event processor
    51       * @param delay The event is dispatched after the delay interval elapses
    52       * @param externalNodes The list of external nodes associated with
    53       *  the &lt;send&gt; element.
    54       */
    55      void send(String sendId, String target, String targetType,
    56              String event, Map params, Object hints, long delay,
    57              List externalNodes);
    58
    59  }
    60