eed9cde4e897b298bd859032f3f3b5f2c6e35f62
[aquarium] / src / main / scala / gr / grnet / aquarium / computation / state / parts / RoleHistoryItem.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.parts
37
38 import gr.grnet.aquarium.util.date.MutableDateCalc
39 import gr.grnet.aquarium.logic.accounting.dsl.Timeslot
40 import gr.grnet.aquarium.Aquarium
41
42 /**
43  *
44  * @author Christos KK Loverdos <loverdos@gmail.com>
45  */
46
47 case class RoleHistoryItem(
48     /**
49      * The role name.
50      */
51     name: String,
52
53     /**
54      * Validity start time for this role. The time is inclusive.
55      */
56     validFrom: Long,
57
58     /**
59      * Validity stop time for this role. The time is exclusive.
60      */
61     validTo: Long = Long.MaxValue
62 ) {
63
64   try {
65     require(
66       validFrom <= validTo,
67       "validFrom(%s) <= validTo(%s)".format(new MutableDateCalc(validFrom), new MutableDateCalc(validTo)))
68   }
69   catch {
70     case e: IllegalArgumentException ⇒
71       // TODO Remove this
72       Aquarium.Instance.debug(this, "!! validFrom = %s, validTo = %s, dx=%s", validFrom, validTo, validTo-validFrom)
73       throw e
74   }
75
76   require(name ne null, "Name is not null")
77
78   require(!name.trim.isEmpty, "Name '%s' is not empty".format(name))
79
80   def timeslot = Timeslot(validFrom, validTo)
81
82   def copyWithValidTo(newValidTo: Long) = copy(validTo = newValidTo)
83
84   def isUpperBounded = {
85     validTo != Long.MaxValue
86   }
87
88   def contains(time: Long) = {
89     validFrom <= time && time < validTo
90   }
91
92   def startsStrictlyAfter(time: Long) = {
93     validFrom > time
94   }
95
96   override def toString =
97     "RoleHistoryItem(%s, [%s, %s))".
98       format(name, new MutableDateCalc(validFrom), new MutableDateCalc(validTo))
99 }