Implement Once behavior with the new scheme. Refactor in the process
[aquarium] / src / main / scala / gr / grnet / aquarium / charging / state / WorkingAgreementHistory.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.immutable
39 import gr.grnet.aquarium.policy.{PolicyDefinedFullPriceTableRef, StdUserAgreement, UserAgreementModel}
40 import gr.grnet.aquarium.util.json.JsonSupport
41 import gr.grnet.aquarium.logic.accounting.dsl.Timeslot
42
43 /**
44  *
45  * @author Christos KK Loverdos <loverdos@gmail.com>
46  */
47
48 final case class WorkingAgreementHistory(
49     var agreements: immutable.SortedSet[UserAgreementModel] = immutable.SortedSet[UserAgreementModel]()
50 ) extends AgreementHistoryModel with JsonSupport {
51
52   def agreementByTimeslot: immutable.SortedMap[Timeslot, UserAgreementModel] = {
53     immutable.TreeMap(agreements.map(ag ⇒ (ag.timeslot, ag)).toSeq: _*)
54   }
55
56   def setFrom(that: WorkingAgreementHistory): this.type = {
57     this.agreements = that.agreements
58     this
59   }
60
61   def +(userAgreement: UserAgreementModel): this.type = {
62     agreements += userAgreement
63     this
64   }
65
66   def +=(userAgreement: UserAgreementModel): Unit = {
67     agreements += userAgreement
68   }
69
70   def ++(userAgreements: Traversable[UserAgreementModel]): this.type = {
71     agreements ++= userAgreements
72     this
73   }
74
75   def ++=(userAgreements: Traversable[UserAgreementModel]): Unit = {
76     agreements ++= userAgreements
77   }
78
79   def oldestAgreement: Option[UserAgreementModel] = {
80     agreements.headOption
81   }
82
83   def newestAgreement: Option[UserAgreementModel] = {
84     agreements.lastOption
85   }
86
87   def agreementInEffectWhen(whenMillis: Long): Option[UserAgreementModel] = {
88     agreements.to(
89       StdUserAgreement("", None, whenMillis, Long.MaxValue, "", PolicyDefinedFullPriceTableRef)
90     ).lastOption
91   }
92
93   def toAgreementHistory = {
94     AgreementHistory(agreements.toList)
95   }
96 }
97