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.api;
36  
37  import org.w3.x2005.x08.addressing.EndpointReferenceType;
38  
39  /**
40   * AgreementAcceptanceFactory
41   * 
42   * Creates a new agreement acceptance instance. A client can register an AgreementAcceptanceHandler with this
43   * instance. This handler is notified by the agreement factory whether or not an agreement was accepted.
44   * 
45   * @author Oliver Waeldrich
46   * 
47   */
48  public interface AgreementAcceptanceFactory
49  {
50  
51      /**
52       * An agreement acceptance factory is resolved via this key in the factory context of a factory action.
53       * 
54       * @see org.ogf.graap.wsag.server.actions.AbstractCreateAgreementAction#getHandlerContext()
55       * @see org.ogf.graap.wsag.server.actions.IActionHandlerContext#getFactoryContext()
56       * @see IAgreementFactoryContext#get(Object)
57       */
58      String AGREEMENT_ACCEPTANCE_FACTORY = "org.ogf.graap.wsag.acceptance.factory";
59  
60      /**
61       * Registers an agreement acceptance handler with an acceptance instance.
62       * 
63       * @param handler
64       *            the handler to register
65       * 
66       * @return the endpoint reference of the agreement acceptance service
67       * 
68       * @see org.ogf.graap.wsag.api.client.AgreementFactoryClient#createPendingAgreement(org.ogf.graap.wsag.api.AgreementOffer,
69       *      EndpointReferenceType)
70       */
71      EndpointReferenceType registerAgreementAccetanceListener( AgreementAcceptanceListener handler );
72  
73  }