2 * Copyright 2011-2012 GRNET S.A. All rights reserved.
4 * Redistribution and use in source and binary forms, with or
5 * without modification, are permitted provided that the following
8 * 1. Redistributions of source code must retain the above
9 * copyright notice, this list of conditions and the following
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.
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.
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.
36 package gr.grnet.aquarium.charging.state
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
46 * @author Christos KK Loverdos <loverdos@gmail.com>
49 trait UserStateModel extends JsonSupport {
52 def idInStore: String = id
54 def parentIDInStore: Option[String]
58 def occurredMillis: Long // When this user state was computed
60 def latestResourceEventOccurredMillis: Long
62 def totalCredits: Double
65 * True iff this user state represents a full billing month.
67 def isFullBillingMonth: Boolean
73 def chargingReason: ChargingReason
75 def previousResourceEvents: List[ResourceEventModel]
77 def implicitlyIssuedStartEvents: List[ResourceEventModel]
79 def accumulatingAmountOfResourceInstance: Map[String, Double]
81 def chargingDataOfResourceInstance: Map[String, Map[String, Any]]
83 def billingPeriodOutOfSyncResourceEventsCounter: Long
85 def agreementHistory: AgreementHistory
87 def walletEntries: List[WalletEntry]
89 def toWorkingUserState(resourceTypesMap: Map[String, ResourceType]): WorkingUserState
91 def newWithChargingReason(changeReason: ChargingReason): UserStateModel
94 object UserStateModel {
96 final val userID = "userID"
97 final val occurredMillis = "occurredMillis"
98 final val isFullBillingMonth = "isFullBillingMonth"
99 final val billingYear = "billingYear"
100 final val billingMonth = "billingMonth"
103 object Names extends NamesT