code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/store/UserStateStore.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.store
  37
  38 import gr.grnet.aquarium.user.UserState
  39 import com.ckkloverdos.maybe.Maybe
  40
  41 /**
  42  * A store for user state snapshots.
  43  *
  44  * This is used to hold snapshots of [[gr.grnet.aquarium.user.UserState]]
  45  *
  46  * @author Christos KK Loverdos <loverdos@gmail.com>
  47  */
  48
  49 trait UserStateStore {
  50
  51   /**
  52    * Store a user state
  53    */
  54   def storeUserState(userState: UserState): Maybe[RecordID]
  55
  56
  57   def storeUserState2(userState: UserState): Maybe[UserState] = {
  58     for {
  59       recordID <- storeUserState(userState)
  60     } yield {
  61       userState.copy(id = recordID.id.toString)
  62     }
  63   }
  64
  65   /**
  66    * Find a state by user ID
  67    */
  68   def findUserStateByUserId(userId: String): Maybe[UserState]
  69
  70   /**
  71    * Find the most up-to-date user state for the particular billing period.
  72    */
  73   def findLatestUserStateForEndOfBillingMonth(userId: String, yearOfBillingMonth: Int, billingMonth: Int): Maybe[UserState]
  74
  75   /**
  76    * Delete a state for a user
  77    */
  78   def deleteUserState(userId: String): Unit
  79 }