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 import org.ogf.graap.wsag.api.AgreementFactoryContext;
38 import org.ogf.graap.wsag.server.engine.WsagEngine;
39 import org.ogf.graap.wsag4j.types.configuration.ImplementationConfigurationType;
40
41 /**
42 * Defines an agreement factory action. An agreement factory action is an action that is executed by an
43 * agreement factory. This can be the creation of an agreement template, the instantiation of an agreement, or
44 * the negotiation of an offer.
45 *
46 * @see AbstractGetTemplateAction
47 * @see AbstractNegotiationAction
48 * @see AbstractCreateAgreementAction
49 *
50 * @author Oliver Waeldrich
51 *
52 */
53 public interface IAction
54 {
55
56 /**
57 * Initializes the action.
58 *
59 * @throws Exception
60 * indicates an error during the initialization of this action. This causes that the action is
61 * not loaded by the system.
62 */
63 void initialize() throws Exception;
64
65 /**
66 *
67 * @return the agreement factory context of this action
68 */
69 AgreementFactoryContext getFactoryContext();
70
71 /**
72 *
73 * @param context
74 * sets the agreement factory context of this action
75 */
76 void setFactoryContext( AgreementFactoryContext context );
77
78 /**
79 *
80 * @return configuration of an action
81 */
82 ImplementationConfigurationType getActionConfiguration();
83
84 /**
85 *
86 * @param configuration
87 * configuration of an action
88 */
89 void setActionConfiguration( ImplementationConfigurationType configuration );
90
91 /**
92 * Returns the WSAG4J engine instance for this handler.
93 *
94 * @return the engine instance
95 */
96 WsagEngine getEngine();
97
98 /**
99 * Sets the WSAG4J engine instance for this handler.
100 *
101 * @param engine
102 * the engine instance
103 */
104 void setEngine( WsagEngine engine );
105 }