code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/charging/state/UserStateModel.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.state
  37
  38 import gr.grnet.aquarium.util.json.JsonSupport
  39 import gr.grnet.aquarium.event.model.resource.ResourceEventModel
  40 import gr.grnet.aquarium.charging.wallet.WalletEntry
  41 import gr.grnet.aquarium.charging.reason.ChargingReason
  42 import gr.grnet.aquarium.policy.ResourceType
  43
  44 /**
  45  *
  46  * @author Christos KK Loverdos <loverdos@gmail.com>
  47  */
  48
  49 trait UserStateModel extends JsonSupport {
  50   def id: String
  51
  52   def idInStore: String = id
  53
  54   def parentIDInStore: Option[String]
  55
  56   def userID: String
  57
  58   def occurredMillis: Long // When this user state was computed
  59
  60   def totalCredits: Double
  61
  62   /**
  63    * True iff this user state represents a full billing month.
  64    */
  65   def isFullBillingMonth: Boolean
  66
  67   def billingYear: Int
  68
  69   def billingMonth: Int
  70
  71   def chargingReason: ChargingReason
  72
  73   def previousResourceEvents: List[ResourceEventModel]
  74
  75   def implicitlyIssuedStartEvents: List[ResourceEventModel]
  76
  77   def accumulatingAmountOfResourceInstance: Map[String, Double]
  78
  79   def chargingDataOfResourceInstance: Map[String, Map[String, Any]]
  80
  81   def billingPeriodOutOfSyncResourceEventsCounter: Long
  82
  83   def agreementHistory: AgreementHistory
  84
  85   def walletEntries: List[WalletEntry]
  86
  87   def toWorkingUserState(resourceTypesMap: Map[String, ResourceType]): WorkingUserState
  88
  89   def newWithChargingReason(changeReason: ChargingReason): UserStateModel
  90 }
  91
  92 object UserStateModel {
  93   trait NamesT {
  94     final val userID = "userID"
  95     final val occurredMillis = "occurredMillis"
  96     final val isFullBillingMonth = "isFullBillingMonth"
  97     final val billingYear = "billingYear"
  98     final val billingMonth = "billingMonth"
  99   }
 100
 101   object Names extends NamesT
 102 }