code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/charging/Chargeslot.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 import gr.grnet.aquarium.util.shortClassNameOf
  39 import gr.grnet.aquarium.util.date.TimeHelpers.toYYYYMMDDHHMMSSSSS
  40
  41 /**
  42  * A credit value computed for a particular time period, using a specific unit price.
  43  *
  44  * @param startMillis
  45  * @param stopMillis
  46  * @param unitPrice
  47  * @param creditsToSubtract The computed amount of credits to subtract from the total user credits. If this is
  48  *                          an infinite number, then the convention is that no credits have been specified.
  49  *
  50  * @author Christos KK Loverdos <loverdos@gmail.com>
  51  */
  52
  53 case class Chargeslot(
  54     startMillis: Long,
  55     stopMillis: Long,
  56     unitPrice: Double,
  57     explanation: String = "",
  58     creditsToSubtract: Double = Double.NaN
  59 ) {
  60
  61   def hasCreditsToSubtract: Boolean = {
  62     !creditsToSubtract.isInfinite
  63   }
  64
  65   def copyWithCreditsToSubtract(credits: Double, _explanation: String) = {
  66     copy(creditsToSubtract = credits, explanation = _explanation)
  67   }
  68
  69   override def toString = "%s(%s, %s, %s, %s, %s)".format(
  70     shortClassNameOf(this),
  71     toYYYYMMDDHHMMSSSSS(startMillis),
  72     toYYYYMMDDHHMMSSSSS(stopMillis),
  73     unitPrice,
  74     explanation,
  75     creditsToSubtract
  76   )
  77 }