Change agreement history model to support the new respective avro message
[aquarium] / src / main / scala / gr / grnet / aquarium / charging / state / UserAgreementHistoryModel.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.logic.accounting.dsl.Timeslot
39 import gr.grnet.aquarium.policy.UserAgreementModel
40 import gr.grnet.aquarium.util.json.JsonSupport
41 import scala.collection.immutable
42 import gr.grnet.aquarium.message.avro.gen.{UserAgreementMsg, IMEventMsg, UserAgreementHistoryMsg}
43 import gr.grnet.aquarium.message.avro.{MessageFactory, MessageHelpers, ModelFactory}
44
45 /**
46  *
47  * @author Christos KK Loverdos <loverdos@gmail.com>
48  */
49
50 final class UserAgreementHistoryModel(msg: UserAgreementHistoryMsg) {
51
52   private[this] var _latestIMEventOccurredMillis = 0L
53
54   private[this] var (_userAgreementModels, _userCreationIMEventMsgOpt): (immutable.SortedSet[UserAgreementModel], Option[IMEventMsg]) = {
55     var userAgreementModels = immutable.SortedSet[UserAgreementModel]()
56     var userCreationIMEventMsg: Option[IMEventMsg] = None
57     val userAgreements = msg.getAgreements.iterator()
58     while(userAgreements.hasNext) {
59       val userAgreement = userAgreements.next()
60       val userAgreementModel = ModelFactory.newUserAgreementModel(userAgreement)
61       userAgreementModels += userAgreementModel
62
63       userAgreement.getRelatedIMEventMsg match {
64         case null ⇒
65
66         case msg ⇒
67           if(MessageHelpers.isIMEventCreate(msg)) {
68             userCreationIMEventMsg = Some(msg)
69           }
70       }
71
72       checkLatestIMEventOccurredMillis(userAgreement.getRelatedIMEventMsg)
73     }
74
75     (userAgreementModels, userCreationIMEventMsg)
76   }
77
78   private[this] def checkLatestIMEventOccurredMillis(imEvent: IMEventMsg) {
79     if(imEvent ne null) {
80       if(this._latestIMEventOccurredMillis < imEvent.getOccurredMillis) {
81         this._latestIMEventOccurredMillis = imEvent.getOccurredMillis
82       }
83     }
84   }
85
86   def latestIMEventOccurredMillis = this._latestIMEventOccurredMillis
87
88   def hasUserCreationEvent = this._userCreationIMEventMsgOpt.isDefined
89
90   def userCreationIMEvent = this._userCreationIMEventMsgOpt
91
92   def size: Int = msg.getAgreements.size()
93
94   def agreementByTimeslot: immutable.SortedMap[Timeslot, UserAgreementModel] = {
95     immutable.TreeMap(_userAgreementModels.map(ag ⇒ (ag.timeslot, ag)).toSeq: _*)
96   }
97
98   def insertUserAgreementModel(userAgreement: UserAgreementModel) {
99     MessageHelpers.insertUserAgreement(this.msg, userAgreement.msg)
100     this._userAgreementModels += userAgreement
101     checkLatestIMEventOccurredMillis(userAgreement.msg.getRelatedIMEventMsg)
102   }
103
104   def insertUserAgreementMsg(userAgreementMsg: UserAgreementMsg) {
105     insertUserAgreementModel(ModelFactory.newUserAgreementModel(userAgreementMsg))
106   }
107
108   def insertUserAgreementMsgFromIMEvent(imEvent: IMEventMsg) {
109     val userAgreementMsg = MessageFactory.newUserAgreementFromIMEventMsg(imEvent)
110     insertUserAgreementMsg(userAgreementMsg)
111   }
112
113   def oldestAgreementModel: Option[UserAgreementModel] = {
114     _userAgreementModels.headOption
115   }
116
117   def newestAgreementModel: Option[UserAgreementModel] = {
118     _userAgreementModels.lastOption
119   }
120
121   override def toString = msg.toString
122
123 //  def agreementInEffectWhen(whenMillis: Long): Option[UserAgreementModel] = {
124 //    agreements.to(
125 //      UserAgreementModel("", None, whenMillis, Long.MaxValue, "", PolicyDefinedFullPriceTableRef())
126 //    ).lastOption
127 //  }
128 }
129