Validate presence of descriminator field in complex resource events
[aquarium] / src / main / scala / gr / grnet / aquarium / logic / accounting / dsl / DSLResource.scala
1 /*
2  * Copyright 2011 GRNET S.A. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or
5  * without modification, are permitted provided that the following
6  * conditions are met:
7  *
8  *   1. Redistributions of source code must retain the above
9  *      copyright notice, this list of conditions and the following
10  *      disclaimer.
11  *
12  *   2. Redistributions in binary form must reproduce the above
13  *      copyright notice, this list of conditions and the following
14  *      disclaimer in the documentation and/or other materials
15  *      provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
18  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
24  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
27  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * The views and conclusions contained in the software and
31  * documentation are those of the authors and should not be
32  * interpreted as representing official policies, either expressed
33  * or implied, of GRNET S.A.
34  */
35
36 package gr.grnet.aquarium.logic.accounting.dsl
37
38 /**
39  * Represents a chargable resource.
40  *
41  * @author Georgios Gousios <gousiosg@gmail.com>
42  */
43 abstract class DSLResource (
44   /** Name of resource */
45   val name: String,
46
47   /** Informative name for resource charging unit*/
48   val unit: String,
49
50   /** Algorithm used to calculate costs */
51   val costpolicy: String
52 ) {
53   def isComplex: Boolean
54 }
55
56 /**
57  * A complex resource can have many chargable instances, separated through
58  * a descriminator field.
59  */
60 case class DSLComplexResource (
61   /**Name of resource */
62   override val name: String,
63
64   /**Informative name for resource charging unit*/
65   override val unit: String,
66
67   /**Algorithm used to calculate costs */
68   override val costpolicy: String,
69
70   /**Name of field used to describe a unique instance of the resource*/
71   descriminatorField: String
72 ) extends DSLResource(name, unit, costpolicy) {
73   override def isComplex = true
74 }
75
76 /**
77  * A simple resource can only have a single chargable instance.
78  */
79 case class DSLSimpleResource (
80   /**Name of resource */
81   override val name: String,
82
83   /**Informative name for resource charging unit*/
84   override val unit: String,
85
86   /**Algorithm used to calculate costs */
87   override val costpolicy: String
88 ) extends DSLResource(name, unit, costpolicy) {
89   override def isComplex = false
90 }