code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/store/PolicyStore.scala

   1 /*
   2  * Copyright 2011 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 com.ckkloverdos.maybe.Maybe
  39 import gr.grnet.aquarium.logic.events.PolicyEntry
  40
  41 /**
  42  * A store for serialized policy entries.
  43  *
  44  * @author Georgios Gousios <gousiosg@gmail.com>
  45  */
  46 trait PolicyStore {
  47
  48   /**
  49    * Load all accounting policies valid after the specified time instance.
  50    * The results are returned sorted by PolicyEntry.validFrom
  51    */
  52   def loadPolicies(after: Long): List[PolicyEntry]
  53
  54   /**
  55    * Store an accounting policy.
  56    */
  57   def storePolicy(policy: PolicyEntry): Maybe[RecordID]
  58
  59   /**
  60    * Updates the policy record whose id is equal to the id
  61    * of the provided policy entry.
  62    */
  63   def updatePolicy(policy: PolicyEntry): Unit
  64
  65   /**
  66    * Find a policy by its unique id
  67    */
  68   def findPolicy(id: String): Maybe[PolicyEntry]
  69 }