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.schemas.graap.wsAgreement.AgreementContextType;
38  import org.ogf.schemas.graap.wsAgreement.AgreementType;
39  import org.ogf.schemas.graap.wsAgreement.TermTreeType;
40  import org.ogf.schemas.graap.wsAgreement.negotiation.NegotiationConstraintSectionType;
41  import org.ogf.schemas.graap.wsAgreement.negotiation.NegotiationOfferContextType;
42  
43  /**
44   * The NegotiationOffer interface implements the required methods to access the properties of a negotiation
45   * offer. Negotiation offers are used in a {@link Negotiation} process in order to negotiate valid
46   * {@link AgreementOffer} instances that can be used to create new {@link Agreement}s with an
47   * {@link AgreementFactory}.
48   * 
49   * @see Negotiation
50   * @see AgreementFactory
51   * @see Agreement
52   * @author hrasheed
53   */
54  public interface NegotiationOffer
55  {
56  
57      /**
58       * @return the agreement id
59       */
60      String getAgreementId();
61  
62      /**
63       * @param id
64       *            agreement id
65       */
66      void setAgreementId( String id );
67  
68      /**
69       * @return the agreement name
70       */
71      String getName();
72  
73      /**
74       * @param name
75       *            the agreement name to set
76       */
77      void setName( String name );
78  
79      /**
80       * @return the agreement context
81       */
82      AgreementContextType getContext();
83  
84      /**
85       * @param context
86       *            the agreement context to set
87       */
88      void setContext( AgreementContextType context );
89  
90      /**
91       * @return the agreement terms
92       */
93      TermTreeType getTerms();
94  
95      /**
96       * @param terms
97       *            the agreement terms to set
98       */
99      void setTerms( TermTreeType terms );
100 
101     /**
102      * @return the negotiation offer context
103      */
104     NegotiationOfferContextType getNegotiationOfferContext();
105 
106     /**
107      * @param context
108      *            the agreement context to set
109      */
110     void setNegotiationOfferContext( NegotiationOfferContextType context );
111 
112     /**
113      * @return the offer id
114      */
115     String getOfferId();
116 
117     /**
118      * @param id
119      *            offer id
120      */
121     void setOfferId( String id );
122 
123     /**
124      * @return the negotiation constraints
125      */
126     NegotiationConstraintSectionType getNegotiationConstraints();
127 
128     /**
129      * @param constraints
130      *            the negotiation constraints to set
131      */
132     void setNegotiationConstraints( NegotiationConstraintSectionType constraints );
133 
134     /**
135      * @return the XML representation of the negotiation offer
136      */
137     AgreementType getXMLObject();
138 
139 }