code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/charging/state/AgreementHistory.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.logic.accounting.dsl.Timeslot
  40 import gr.grnet.aquarium.policy.UserAgreementModel
  41
  42 /**
  43  * The whole history of of a user's agreements.
  44  *
  45  * @author Christos KK Loverdos <loverdos@gmail.com>
  46  */
  47
  48 case class AgreementHistory(agreements: List[UserAgreementModel]) extends AgreementHistoryModel {
  49   def toWorkingAgreementHistory = {
  50     (new WorkingAgreementHistory) ++ agreements
  51   }
  52
  53   def agreementByTimeslot: immutable.SortedMap[Timeslot, UserAgreementModel] = {
  54     immutable.TreeMap(agreements.map(ag ⇒ (ag.timeslot, ag)): _*)
  55   }
  56
  57   /**
  58    * Returns the first, chronologically, agreement.
  59    */
  60   def firstAgreement: Option[UserAgreementModel] = {
  61     agreementByTimeslot.valuesIterator.toList.lastOption
  62   }
  63
  64   /**
  65    * Returns the last, chronologically, agreement.
  66    */
  67   def lastAgreement: Option[UserAgreementModel] = {
  68     agreementByTimeslot.valuesIterator.toList.headOption
  69   }
  70 }
  71
  72 object AgreementHistory {
  73   final val Empty = AgreementHistory(Nil)
  74
  75   def initial(userAgreement: UserAgreementModel): AgreementHistory = {
  76     AgreementHistory(userAgreement :: Nil)
  77   }
  78 }