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.AgreementTemplateType;
39  import org.ogf.schemas.graap.wsAgreement.ConstraintSectionType;
40  import org.ogf.schemas.graap.wsAgreement.TermTreeType;
41  
42  /**
43   * The AgreementTemplate interface implements the required methods to access the properties of an agreement
44   * template. Agreement templates are used to create new {@link AgreementOffer} instances.
45   * 
46   * @see AgreementOffer
47   * @author Oliver Waeldrich
48   */
49  public interface AgreementTemplate
50  {
51  
52      /**
53       * @return the template name
54       */
55      String getName();
56  
57      /**
58       * @param name
59       *            the template name to set
60       */
61      void setName( String name );
62  
63      /**
64       * @return the agreement id
65       */
66      String getAgreementId();
67  
68      /**
69       * @param id
70       *            the agreement id to set
71       */
72      void setAgreementId( String id );
73  
74      /**
75       * @return the template id
76       */
77      String getTemplateId();
78  
79      /**
80       * @param id
81       *            the template id to set
82       */
83      void setTemplateId( String id );
84  
85      /**
86       * @return the agreement context
87       */
88      AgreementContextType getContext();
89  
90      /**
91       * @param context
92       *            the context to set
93       */
94      void setContext( AgreementContextType context );
95  
96      /**
97       * @return the agreement terms
98       */
99      TermTreeType getTerms();
100 
101     /**
102      * @param terms
103      *            the terms to set
104      */
105     void setTerms( TermTreeType terms );
106 
107     /**
108      * @return the template creation constraints
109      */
110     ConstraintSectionType getCreationConstraints();
111 
112     /**
113      * @param constraints
114      *            the creation constraints to set
115      */
116     void setCreationConstraints( ConstraintSectionType constraints );
117 
118     /**
119      * @return the XML representation of the template
120      */
121     AgreementTemplateType getXMLObject();
122 }