code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/logic/events/NewWalletEntry.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.events
  37
  38 import gr.grnet.aquarium.logic.accounting.Chargeslot
  39 import gr.grnet.aquarium.util.json.JsonHelpers
  40 import gr.grnet.aquarium.util.date.MutableDateCalc
  41 import gr.grnet.aquarium.logic.accounting.dsl.{Timeslot, DSLResource}
  42
  43 /**
  44  * The following equation must hold: `newTotalCredits = oldTotalCredits + entryCredits`.
  45  *
  46  * @author Christos KK Loverdos <loverdos@gmail.com>
  47  *
  48  * @param userId The user ID this wallet entry is related to.
  49  * @param entryCredits The credit amount generated for this wallet entry.
  50  * @param oldTotalCredits
  51  * @param newTotalCredits
  52  * @param whenComputedMillis When the computation took place
  53  * @param yearOfBillingMonth
  54  * @param billingMonth
  55  * @param resourceEvents
  56  * @param chargeslots The details of the credit computation
  57  * @param resourceDef
  58  */
  59 case class NewWalletEntry(userId: String,
  60                           entryCredits: Double,
  61                           oldTotalCredits: Double,
  62                           newTotalCredits: Double,
  63                           whenComputedMillis: Long,
  64                           referenceTimeslot: Timeslot,
  65                           yearOfBillingMonth: Int,
  66                           billingMonth: Int,
  67                           resourceEvents: List[ResourceEvent], // current is at the head
  68                           chargeslots: List[Chargeslot],
  69                           resourceDef: DSLResource,
  70                           isSynthetic: Boolean) {
  71
  72   def currentResourceEvent = resourceEvents.head
  73   def resource = currentResourceEvent.resource
  74   def instanceId = currentResourceEvent.instanceId
  75   def chargslotCount = chargeslots.length
  76   def isOutOfSync = currentResourceEvent.isOutOfSyncForBillingMonth(yearOfBillingMonth, billingMonth)
  77
  78   def toDebugString = "%s%s(%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s)".format(
  79     if(isSynthetic) "*" else "",
  80     gr.grnet.aquarium.util.shortClassNameOf(this),
  81     userId,
  82     referenceTimeslot,
  83     entryCredits,
  84     oldTotalCredits,
  85     newTotalCredits,
  86     new MutableDateCalc(whenComputedMillis).toYYYYMMDDHHMMSSSSS,
  87     yearOfBillingMonth,
  88     billingMonth,
  89     resourceEvents,
  90     chargeslots,
  91     resourceDef
  92   )
  93 }
  94
  95 object NewWalletEntry {
  96   def fromJson(json: String): NewWalletEntry = {
  97     JsonHelpers.jsonToObject[NewWalletEntry](json)
  98   }
  99
 100   object JsonNames {
 101     final val _id = "_id"
 102     final val id = "id"
 103     final val entryCredits = "entryCredits"
 104     final val oldTotalCredits = "oldTotalCredits"
 105     final val newTotalCredits = "newTotalCredits"
 106     final val whenComputedMillis = "whenComputedMillis"
 107     final val yearOfBillingMonth = "yearOfBillingMonth"
 108     final val billingMonth = "billingMonth"
 109     final val currentResourceEvent = "currentResourceEvent"
 110     final val previousResourceEvent = "previousResourceEvent"
 111     final val chargeslots = "chargeslots"
 112     final val resourceDef = "resourceDef"
 113   }
 114 }