View Javadoc

1   /* 
2    * Copyright (c) 2007, Fraunhofer-Gesellschaft
3    * All rights reserved.
4    * 
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions are
7    * met:
8    * 
9    * (1) Redistributions of source code must retain the above copyright
10   *     notice, this list of conditions and the disclaimer at the end.
11   *     Redistributions in binary form must reproduce the above copyright
12   *     notice, this list of conditions and the following disclaimer in
13   *     the documentation and/or other materials provided with the
14   *     distribution.
15   * 
16   * (2) Neither the name of Fraunhofer nor the names of its
17   *     contributors may be used to endorse or promote products derived
18   *     from this software without specific prior written permission.
19   * 
20   * DISCLAIMER
21   * 
22   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25   * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26   * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33   *  
34   */
35  package org.ogf.graap.wsag.server.actions;
36  
37  /**
38   * <!-- begin-UML-doc --> An action handler provides the functionality that is executed for a specific
39   * invocation of an agreement factory. <!-- end-UML-doc -->
40   * 
41   * @author Oliver Waeldrich
42   * @generated "UML to Java (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransform)"
43   */
44  public interface IActionHandler
45  {
46      /**
47       * <!-- begin-UML-doc --> Sets&nbsp;the context for this action handler. <!-- end-UML-doc -->
48       * 
49       * @param context
50       *            Sets the context for this handler instance. A handler uses the context i.e. to look up the
51       *            handler configuration during initialization.
52       * 
53       * @see IActionHandlerContext
54       * 
55       * @generated "UML to Java (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransform)"
56       */
57      void setHandlerContext( IActionHandlerContext context );
58  
59      /**
60       * <!-- begin-UML-doc --> Returns the context of&nbsp;this action handler. <!-- end-UML-doc -->
61       * 
62       * @return the current handler context
63       * 
64       * @generated "UML to Java (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransform)"
65       */
66      IActionHandlerContext getHandlerContext();
67  
68      /**
69       * <!-- begin-UML-doc --> Initializes an action handler. This method is called when a agreement factory
70       * action initializes its action handlers. It is called once during the the engine initialization. <!--
71       * end-UML-doc -->
72       * 
73       * @throws ActionInitializationException
74       *             Indicates an error during handler initialization.
75       * 
76       * @generated "UML to Java (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransform)"
77       */
78      void initialize() throws ActionInitializationException;
79  }