code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/charging/ChargingInput.scala

   1 /*
   2  * Copyright 2011-2012 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.charging
  37
  38 /**
  39  * An input that is used in a charging function.
  40  *
  41  * @author Christos KK Loverdos <loverdos@gmail.com>
  42  */
  43
  44 sealed abstract class ChargingInput(
  45     val name: String,
  46     val isDirectlyRelatedToPreviousEvent: Boolean = false,
  47     val isDirectlyRelatedToCurrentEvent: Boolean = false
  48 )
  49
  50 /**
  51  * The type of [[gr.grnet.aquarium.charging.ChargingInput]] that holds the name of the cost
  52  * policy for which a cost computation applies.
  53  *
  54  * @author Christos KK Loverdos <loverdos@gmail.com>
  55  */
  56 case object ChargingBehaviorNameInput extends ChargingInput("chargingBehaviorName")
  57
  58 /**
  59  * The type of [[gr.grnet.aquarium.charging.ChargingInput]] that holds the total credits.
  60  *
  61  * @author Christos KK Loverdos <loverdos@gmail.com>
  62  */
  63 case object TotalCreditsInput extends ChargingInput("totalCredits")
  64
  65 /**
  66  * The type of [[gr.grnet.aquarium.charging.ChargingInput]] that holds the old total (accumulating)
  67  * amount, that is the resource amount before taking into account a new resource event.
  68  * For example, in the case of `diskspace`, this is the total diskspace used by a user.
  69  *
  70  * @author Christos KK Loverdos <loverdos@gmail.com>
  71  */
  72 case object OldTotalAmountInput extends ChargingInput("oldTotalAmount")
  73
  74 /**
  75  * The type of [[gr.grnet.aquarium.charging.ChargingInput]] that holds the new total (accumulating)
  76  * amount, that is the resource amount after taking into account a new resource event.
  77  * For example, in the case of `diskspace`, this is the total diskspace used by a user.
  78  *
  79  * @author Christos KK Loverdos <loverdos@gmail.com>
  80  */
  81 case object NewTotalAmountInput extends ChargingInput("newTotalAmount")
  82
  83 /**
  84  * The type of [[gr.grnet.aquarium.charging.ChargingInput]] that holds the time delta between two
  85  * consecutive resource events of the same type (same `resource` and `instanceID`). Time is measured in milliseconds.
  86  *
  87  * @author Christos KK Loverdos <loverdos@gmail.com>
  88  */
  89 case object TimeDeltaInput extends ChargingInput("timeDelta", true, true)
  90
  91 /**
  92  * The type of [[gr.grnet.aquarium.charging.ChargingInput]] that holds the `value` of the previous
  93  * [[gr.grnet.aquarium.event.model.resource.ResourceEventModel]].
  94  *
  95  * @author Christos KK Loverdos <loverdos@gmail.com>
  96  */
  97 case object PreviousValueInput extends ChargingInput("previousValue", true, false)
  98
  99 /**
 100  * The type of [[gr.grnet.aquarium.charging.ChargingInput]] that holds the `value` of the current
 101  * [[gr.grnet.aquarium.event.model.resource.ResourceEventModel]].
 102  *
 103  * @author Christos KK Loverdos <loverdos@gmail.com>
 104  */
 105 case object CurrentValueInput extends ChargingInput("currentValue", false, true)
 106
 107 /**
 108  * The type of [[gr.grnet.aquarium.charging.ChargingInput]] that holds the unit price.
 109  *
 110  * @author Christos KK Loverdos <loverdos@gmail.com>
 111  */
 112 case object UnitPriceInput extends ChargingInput("unitPrice")
 113
 114 case object DetailsInput extends ChargingInput("details")
 115
 116
 117
 118