PushWithReturn


1   /**
2    * Dream
3    * Copyright (C) 2003-2004 INRIA Rhone-Alpes
4    *
5    * This library is free software; you can redistribute it and/or
6    * modify it under the terms of the GNU Lesser General Public
7    * License as published by the Free Software Foundation; either
8    * version 2 of the License, or (at your option) any later version.
9    *
10   * This library is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13   * Lesser General Public License for more details.
14   *
15   * You should have received a copy of the GNU Lesser General Public
16   * License along with this library; if not, write to the Free Software
17   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   *
19   * Contact : dream@objectweb.org
20   *
21   * Initial developer(s): Vivien Quema
22   * Contributor(s):
23   */
24  
25  package org.objectweb.dream;
26  
27  import java.util.Map  ;
28  
29  import org.objectweb.dream.message.Message;
30  
31  /**
32   * This interface extends the {@link Push}interface for allowing Dream
33   * components to push messages with a return.
34   */
35  public interface PushWithReturn extends Push
36  {
37    /**
38     * The commonly used name to refer to this interface when it is used as an
39     * output.
40     */
41    String   OUT_PUSH_WITH_RETURN_ITF_NAME = "out-push-with-return";
42  
43    /**
44     * The commonly used name to refer to this interface when it is used as an
45     * input.
46     */
47    String   IN_PUSH_WITH_RETURN_ITF_NAME  = "in-push-with-return";
48  
49    /**
50     * Gives a message to a component.
51     * 
52     * @param message the message to give to the component.
53     * @param context a general purpose context map. Can be <code>null</code>.
54     * @return a message.
55     * @throws PushException if an exception occurs.
56     */
57    Message pushWithReturn(Message message, Map   context) throws PushException;;
58  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags