2 * Copyright 2011 GRNET S.A. All rights reserved.
4 * Redistribution and use in source and binary forms, with or
5 * without modification, are permitted provided that the following
8 * 1. Redistributions of source code must retain the above
9 * copyright notice, this list of conditions and the following
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.
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.
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.
36 package gr.grnet.aquarium.store
38 import com.ckkloverdos.maybe.Maybe
39 import gr.grnet.aquarium.logic.events.ResourceEvent
42 * An abstraction for Aquarium `ResourceEvent` stores.
44 * @author Christos KK Loverdos <loverdos@gmail.com>.
45 * @author Georgios Gousios <gousiosg@gmail.com>.
47 trait ResourceEventStore {
48 def storeResourceEvent(event: ResourceEvent): Maybe[RecordID]
50 def findResourceEventById(id: String): Maybe[ResourceEvent]
52 def findResourceEventsByUserId(userId: String)(sortWith: Option[(ResourceEvent, ResourceEvent) => Boolean]): List[ResourceEvent]
55 * Returns the events for the given User after (or equal) the given timestamp.
57 * The events are returned in ascending timestamp order.
59 def findResourceEventsByUserIdAfterTimestamp(userId: String, timestamp: Long): List[ResourceEvent]
61 def findResourceEventHistory(userId: String, resName: String,
62 instid: Option[String], upTo: Long) : List[ResourceEvent]
64 def findResourceEventsForReceivedPeriod(userId: String, startTimeMillis: Long, stopTimeMillis: Long): List[ResourceEvent]
67 * Count and return the number of "out of sync" events for a billing month.
69 def countOutOfSyncEventsForBillingPeriod(userId: String, startMillis: Long, stopMillis: Long): Maybe[Long]
72 * Finds all relevant resource events for the billing period.
73 * The relevant events are those:
74 * a) whose `occurredMillis` is within the given billing period or
75 * b) whose `receivedMillis` is within the given billing period.
77 * Order them by `occurredMillis`
80 def findAllRelevantResourceEventsForBillingPeriod(userId: String,
82 stopMillis: Long): List[ResourceEvent]