View Javadoc

1   /*
2    * Copyright  2004-2005 Stefan Reuter
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   *
16   */
17  package net.sf.asterisk.manager;
18  
19  import java.util.Collection;
20  
21  import net.sf.asterisk.manager.response.ManagerResponse;
22  
23  /***
24   * Contains the result of executing an EventGeneratingAction, that is the
25   * ManagerResponse and any received ManagerEvents.
26   * 
27   * @see net.sf.asterisk.manager.action.EventGeneratingAction
28   * @author srt
29   * @version $Id: ResponseEvents.java,v 1.1 2005/07/16 21:48:15 srt Exp $
30   * @since 0.2
31   */
32  public interface ResponseEvents
33  {
34      /***
35       * Returns the ManagerResponse received.
36       * 
37       * @return the ManagerResponse received.
38       */
39      ManagerResponse getResponse();
40  
41      /***
42       * Returns a Collection of ManagerEvents that have been received including
43       * the last one that indicates completion.
44       * 
45       * @return a Collection of ManagerEvents received.
46       */
47      Collection getEvents();
48  }