class Crystime::Item
- Crystime::Item
- Reference
- Object
Defined in:
crystime/item.crInstance Method Summary
- #due : Array(Crystime::VirtualTime | Time)
- #due=(due : Array(Crystime::VirtualTime | Time))
-
#due_on?(target, list = @due)
Checks if item is due on any of its date and time specifications.
-
#due_on_date?(target, list = @due)
Checks if item is due on any of its date specifications (without times).
-
#due_on_time?(target, list = @due)
Checks if item is due on any of its time specifications (without dates).
- #omit : Array(Crystime::VirtualTime | Time)
- #omit=(omit : Array(Crystime::VirtualTime | Time))
-
#omit_on?(target)
Checks if item is omitted on any of its date and time specifications.
-
#omit_on_date?(target)
Checks if item is omitted on any of its date specifications (without times).
-
#omit_on_time?(target)
Checks if item is omitted on any of its time specifications (without dates).
- #omit_shift : Bool | Crystime::Span | Time::Span | Nil
- #omit_shift=(omit_shift : Bool | Crystime::Span | Time::Span | Nil)
-
#on?(date = VirtualTime.local, max_before = nil, max_after = max_before, max_shifts = 1000)
Checks whether the item is "on" on the specified date/time.
- #shift : Array(Crystime::VirtualTime | Time)
- #shift=(shift : Array(Crystime::VirtualTime | Time))
- #start : Crystime::VirtualTime | Time | Nil
- #start=(start : Crystime::VirtualTime | Time | Nil)
- #stop : Crystime::VirtualTime | Time | Nil
- #stop=(stop : Crystime::VirtualTime | Time | Nil)
Instance Method Detail
Checks if item is due on any of its date and time specifications.
Checks if item is due on any of its date specifications (without times).
Checks if item is due on any of its time specifications (without dates).
Checks if item is omitted on any of its date specifications (without times).
Checks if item is omitted on any of its time specifications (without dates).
Checks whether the item is "on" on the specified date/time. Item is considered "on" if it matches at least one "due" time and does not match any "omit" time. If it matches an omit time, then depending on the value of omit_shift it may still be "on", or attempted to be rescheduled. Return values are: nil - item is not "on" / not "due" true - item is "on" (it is "due" and not on "omit" list) false - item is due, but that date is omitted, and no reschedule was requested or possible, so effectively it is not "on" Time::Span - span which is to be added to asked date to reach the earliestclosest time when item is "on"