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  import java.util.Map;
38  
39  import org.ogf.graap.wsag.api.exceptions.NegotiationException;
40  import org.ogf.schemas.graap.wsAgreement.negotiation.NegotiationOfferType;
41  
42  /**
43   * <!-- begin-UML-doc -->
44   * <p>
45   * A negotiation action handler implements the functionality to create negotiate agreement offers based on a
46   * template. It is associated with a specific agreement factory action.
47   * </p>
48   * <!-- end-UML-doc -->
49   * 
50   * @author Oliver Waeldrich
51   * @generated "UML to Java (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransform)"
52   */
53  public interface INegotiationAction
54      extends IActionHandler
55  {
56  
57      /**
58       * Negotiates an agreement offer. For each negotiation offer, one or more counter proposals may be
59       * created. A negotiation request can comprise multiple negotiation offers. These offers are processed
60       * sequentially, sharing a common invocation context.
61       * 
62       * @param quote
63       *            the negotiation offer to process
64       * @param context
65       *            the invocation context
66       * @return a set of counter offers
67       * 
68       * @throws NegotiationException
69       *             indicates an error during the negotiation process
70       */
71      NegotiationOfferType[] negotiate( NegotiationOfferType quote, Map<String, Object> context )
72          throws NegotiationException;
73  }