3b6c47cd5e5b31402f363dfde097ffce5538d270
[aquarium] / src / main / scala / gr / grnet / aquarium / charging / state / UserStateModelSkeleton.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 scala.collection.mutable
39 import gr.grnet.aquarium.charging.wallet.WalletEntry
40 import gr.grnet.aquarium.policy.ResourceType
41
42 /**
43  * Provides common, helper operations for a [[gr.grnet.aquarium.charging.state.UserStateModel]].
44  *
45  * @author Christos KK Loverdos <loverdos@gmail.com>
46  */
47
48 abstract class UserStateModelSkeleton extends UserStateModel {
49   protected def mutableStateOfChargingBehavior: mutable.Map[String, WorkingResourcesChargingState] = {
50     val contents = for((k, v) ← stateOfResources) yield (k, v.toWorkingResourcesChargingState)
51     mutable.Map(contents.toSeq: _*)
52   }
53
54   protected def mutableWalletEntries = {
55     val buffer = new mutable.ListBuffer[WalletEntry]
56     buffer ++= this.walletEntries
57     buffer
58   }
59
60   protected def mutableAgreementHistory = {
61     this.agreementHistory.toWorkingAgreementHistory
62   }
63
64   def toWorkingUserState(resourceTypesMap: Map[String, ResourceType]): WorkingUserState = {
65     new WorkingUserState(
66       this.userID,
67       this.parentIDInStore,
68       resourceTypesMap,
69       mutableStateOfChargingBehavior,
70       this.totalCredits,
71       mutableAgreementHistory,
72       this.occurredMillis,
73       this.latestResourceEventOccurredMillis,
74       this.billingPeriodOutOfSyncResourceEventsCounter,
75       mutableWalletEntries
76     )
77   }
78 }