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;
36  
37  import org.ogf.graap.wsag.api.types.AbstractAgreementType;
38  import org.ogf.schemas.graap.wsAgreement.AgreementContextType;
39  import org.ogf.schemas.graap.wsAgreement.AgreementStateType;
40  import org.ogf.schemas.graap.wsAgreement.GuaranteeTermStateType;
41  import org.ogf.schemas.graap.wsAgreement.ServiceTermStateType;
42  import org.ogf.schemas.graap.wsAgreement.TermTreeType;
43  import org.ogf.schemas.graap.wsAgreement.TerminateInputType;
44  
45  /**
46   * Agreement interface used by the server module. It provides the required methods to access the properties of
47   * the agreement and to terminate the agreement instance. Moreover, it provides access to the domains-specific
48   * agreement implementation via the {@link #getAgreementInstance()} method.
49   * 
50   * @see AgreementFactory
51   * @author Oliver Waeldrich
52   */
53  public interface Agreement
54  {
55  
56      // definitions from the ArgreementPortType
57  
58      /**
59       * Returns the agreement name.
60       * 
61       * @return the agreement name
62       */
63      String getName();
64  
65      /**
66       * Returns the agreement id.
67       * 
68       * @return the agreement id
69       */
70      String getAgreementId();
71  
72      /**
73       * Returns a domain-specific agreement implementation. The {@link AbstractAgreementType} implements the
74       * domain-specific termination method and stored the agreement properties. The
75       * {@link AbstractAgreementType#getXMLObject()} returns the actual properties of an agreement
76       * implementation. These properties must be valid at all time, i.e. if an agreement implementation
77       * overrides the {@link #getState()} method the implementation must make sure that the agreement
78       * properties are updated with the returned state.
79       * 
80       * @return the agreement implementation
81       */
82      AbstractAgreementType getAgreementInstance();
83  
84      /**
85       * @return the agreement context
86       */
87      AgreementContextType getContext();
88  
89      /**
90       * @return the agreement terms
91       */
92      TermTreeType getTerms();
93  
94      /**
95       * Terminates an agreement.
96       * 
97       * @param reason
98       *            termination reason
99       */
100     void terminate( TerminateInputType reason );
101 
102     // definitions from the ArgreementStatePortType
103 
104     /**
105      * @return the agreement state
106      */
107     AgreementStateType getState();
108 
109     /**
110      * @return the agreement guarantee term states
111      */
112     GuaranteeTermStateType[] getGuaranteeTermStates();
113 
114     /**
115      * @return the agreement service term states
116      */
117     ServiceTermStateType[] getServiceTermStates();
118 
119 }