View Javadoc

1   /*
2    *  Copyright 2004-2006 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 org.asteriskjava.manager.action;
18  
19  /***
20   * The EventGeneratingAction interface is implemented by ManagerActions that
21   * return their result not in a ManagerResponse but by sending a series of
22   * events.<p>
23   * The event type that indicates that Asterisk is finished is returned by the
24   * getActionCompleteEventClass() method.
25   * 
26   * @see org.asteriskjava.manager.event.ResponseEvent
27   * @author srt
28   * @version $Id: EventGeneratingAction.java 397 2006-05-26 12:13:32Z srt $
29   * @since 0.2
30   */
31  public interface EventGeneratingAction extends ManagerAction
32  {
33      /***
34       * Returns the event type that indicates that Asterisk is finished sending
35       * response events for this action.
36       * 
37       * @return a Class that is an instance of ResponseEvent.
38       * @see org.asteriskjava.manager.event.ResponseEvent
39       */
40      Class getActionCompleteEventClass();
41  }