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.accounting;
36  
37  import java.util.Map;
38  
39  import org.ogf.schemas.graap.wsAgreement.GuaranteeTermType;
40  
41  /**
42   * IAccountingContext
43   * 
44   * The accounting context is the basic reference to a particular accounting event. Accounting events are
45   * generated as part of the agreement monitoring and guarantee evaluation process. Each time a guarantee is
46   * evaluated an appropriate accounting event is generated. The accounting context specifies the guarantee that
47   * was evaluated, the evaluation result, and additional properties.
48   * 
49   * @author Oliver Waeldrich
50   * 
51   */
52  public interface IAccountingContext
53  {
54  
55      /**
56       * 
57       * @return the guarantee that was evaluated
58       */
59      GuaranteeTermType getGuarantee();
60  
61      /**
62       * 
63       * @param guarantee
64       *            the guarantee that was evaluated
65       */
66      void setGuarantee( GuaranteeTermType guarantee );
67  
68      /**
69       * 
70       * @return the evaluation result
71       */
72      boolean getEvaluationResult();
73  
74      /**
75       * 
76       * @param result
77       *            the evaluation result
78       */
79      void setEvaluationResult( boolean result );
80  
81      /**
82       * @return the evaluation context properties
83       */
84      Map<String, Object> getProperties();
85  
86      /**
87       * 
88       * @param properties
89       *            the evaluation context properties
90       */
91      void setProperties( Map<String, Object> properties );
92  
93  }