code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/computation/reason/UserStateChangeReason.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.computation.reason
  37
  38 import gr.grnet.aquarium.computation.BillingMonthInfo
  39 import gr.grnet.aquarium.event.model.im.IMEventModel
  40
  41 sealed trait UserStateChangeReason {
  42   /**
  43     * Return `true` if the result of the calculation should be stored back to the
  44     * [[gr.grnet.aquarium.store.UserStateStore]].
  45     *
  46     */
  47   def shouldStoreUserState: Boolean
  48
  49   def shouldStoreCalculatedWalletEntries: Boolean
  50
  51   def forPreviousBillingMonth: UserStateChangeReason
  52
  53   def calculateCreditsForImplicitlyTerminated: Boolean
  54
  55   def code: UserStateChangeReasonCodes.ChangeReasonCode
  56 }
  57
  58 case object InitialUserStateSetup extends UserStateChangeReason {
  59   def shouldStoreUserState = true
  60
  61   def shouldStoreCalculatedWalletEntries = false
  62
  63   def forPreviousBillingMonth = this
  64
  65   def calculateCreditsForImplicitlyTerminated = false
  66
  67   def code = UserStateChangeReasonCodes.InitialSetupCode
  68 }
  69 /**
  70  * A calculation made for no specific reason. Can be for testing, for example.
  71  *
  72  */
  73 case object NoSpecificChangeReason extends UserStateChangeReason {
  74   def shouldStoreUserState = false
  75
  76   def shouldStoreCalculatedWalletEntries = false
  77
  78   def forBillingMonthInfo(bmi: BillingMonthInfo) = this
  79
  80   def forPreviousBillingMonth = this
  81
  82   def calculateCreditsForImplicitlyTerminated = false
  83
  84   def code = UserStateChangeReasonCodes.NoSpecificChangeCode
  85 }
  86
  87 /**
  88  * An authoritative calculation for the billing period.
  89  *
  90  * This marks a state for caching.
  91  *
  92  * @param billingMonthInfo
  93  */
  94 case class MonthlyBillingCalculation(billingMonthInfo: BillingMonthInfo) extends UserStateChangeReason {
  95   def shouldStoreUserState = true
  96
  97   def shouldStoreCalculatedWalletEntries = true
  98
  99   def forPreviousBillingMonth = MonthlyBillingCalculation(billingMonthInfo.previousMonth)
 100
 101   def calculateCreditsForImplicitlyTerminated = true
 102
 103   def code = UserStateChangeReasonCodes.MonthlyBillingCode
 104 }
 105
 106 /**
 107  * Used for the realtime billing calculation.
 108  *
 109  * @param forWhenMillis The time this calculation is for
 110  */
 111 case class RealtimeBillingCalculation(forWhenMillis: Long) extends UserStateChangeReason {
 112   def shouldStoreUserState = false
 113
 114   def shouldStoreCalculatedWalletEntries = false
 115
 116   def forPreviousBillingMonth = this
 117
 118   def calculateCreditsForImplicitlyTerminated = false
 119
 120   def code = UserStateChangeReasonCodes.RealtimeBillingCode
 121 }
 122
 123 case class IMEventArrival(imEvent: IMEventModel) extends UserStateChangeReason {
 124   def shouldStoreUserState = true
 125
 126   def shouldStoreCalculatedWalletEntries = false
 127
 128   def forPreviousBillingMonth = this
 129
 130   def calculateCreditsForImplicitlyTerminated = false
 131
 132   def code = UserStateChangeReasonCodes.IMEventArrivalCode
 133 }