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.api.client;
36  
37  import org.ogf.graap.wsag.api.exceptions.ResourceUnavailableException;
38  import org.ogf.graap.wsag.api.exceptions.ResourceUnknownException;
39  import org.ogf.schemas.graap.wsAgreement.negotiation.NegotiationOfferType;
40  
41  /**
42   * NegotiationClient
43   * 
44   * @author hrasheed
45   */
46  public interface NegotiationClient
47      extends WsClient, NegotiationService
48  {
49  
50      /**
51       * Returns the Negotiation Offer with the given offer id
52       * 
53       * @param offerID
54       *            the offerID of the negotiation offer to retrieve
55       * @return the negotiation offer with the given offer id
56       * @throws ResourceUnknownException
57       *             the remote resource is unknown
58       * @throws ResourceUnavailableException
59       *             the remote resource is unavailable
60       */
61      NegotiationOfferType getNegotiationOffer( String offerID )
62          throws ResourceUnknownException, ResourceUnavailableException;
63  
64      /**
65       * Terminates a negotiation.
66       * 
67       * @throws ResourceUnknownException
68       *             the remote resource is unknown
69       * @throws ResourceUnavailableException
70       *             the remote resource is unavailable
71       */
72      void terminate() throws ResourceUnknownException, ResourceUnavailableException;
73  
74      /**
75       * Returns a copy of the client.
76       * 
77       * @return the cloned NegotiationClient
78       * @throws CloneNotSupportedException
79       *             indicates that a particular client implementation does not support cloning
80       */
81      NegotiationClient clone() throws CloneNotSupportedException;
82  
83  }