1 /*
2 * Copyright (c) 2005-2011, 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.NoncriticalExtensionType;
40 import org.ogf.schemas.graap.wsAgreement.TermTreeType;
41 import org.w3.x2005.x08.addressing.EndpointReferenceType;
42
43 /**
44 * The AgreementOffer interface implements the required methods to access the properties of an agreement
45 * offer. Agreement offers are used to create new {@link Agreement} instances with an {@link AgreementFactory}
46 * .
47 *
48 * @see Agreement
49 * @see AgreementFactory
50 * @author Oliver Waeldrich
51 */
52 public interface AgreementOffer
53 {
54
55 /**
56 * @return the agreement id
57 */
58 String getAgreementId();
59
60 /**
61 * @param id
62 * agreement id
63 */
64 void setAgreementId( String id );
65
66 /**
67 * @return the agreement name
68 */
69 String getName();
70
71 /**
72 * @param name
73 * the agreement name to set
74 */
75 void setName( String name );
76
77 /**
78 * @return the agreement context
79 */
80 AgreementContextType getContext();
81
82 /**
83 * @param context
84 * the agreement context to set
85 */
86 void setContext( AgreementContextType context );
87
88 /**
89 * @return the agreement terms
90 */
91 TermTreeType getTerms();
92
93 /**
94 * @param terms
95 * the agreement terms to set
96 */
97 void setTerms( TermTreeType terms );
98
99 /**
100 * @return the initiator agreement EPR
101 */
102 EndpointReferenceType getInitiatorEPR();
103
104 /**
105 * @param initiator
106 * the initiator agreement EPR to set
107 */
108 void setInitiatorEPR( EndpointReferenceType initiator );
109
110 /**
111 * @return the non-critical extensions of an offer
112 */
113 NoncriticalExtensionType[] getNoncriticalExtensions();
114
115 /**
116 * @param extension
117 * the non-critical extensions to set
118 */
119 void setNoncriticalExtensions( NoncriticalExtensionType[] extension );
120
121 /**
122 * @return the XML representation of the offer
123 */
124 AgreementType getXMLObject();
125
126 }