com.azalient.api.b.parameters
Interface ITerm

All Superinterfaces:

IRecord, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

public interface ITerm
extends StoreRecordRW

A Term is an interval in time, on any day, a specific day, or a group of days.

Field Summary

static String	NAME_PREFIX The name pattern for new objects of this type
static ITerm[]	ZERO A static zero-length array, created for convenience, and to save memory

Fields inherited from interface com.azalient.api.a.tables.IRecord

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

boolean	appliesAt(UTime t, DayOfWeek day) Returns true if the term matches time and day.
DayOfWeek	day() Returns the day of the week for this term
void	day(DayOfWeek day) Sets the day of the week for this term
UTime	duration() Returns the he duration of the term (= end - start)
UTime	end() Returns the end time of the term
void	end(UTime s) Sets the end time of the term
UTime	start() Returns the start time of the term
void	start(UTime s) Sets the start time of the term

Methods inherited from interface com.azalient.api.file.StoreRecordRW

canRename, rename, store

Methods inherited from interface com.azalient.api.file.RecordR

extraSet, finished, isApplicable, isEditable, set

Methods inherited from interface com.azalient.api.a.tables.IRecord

name

Methods inherited from interface com.azalient.api.file.RecordW

extraCols, extraGet, extraGetB, extraGetD, extraGetI, extraGetS, extraGetT, get, isVolatile

Field Detail

ZERO

static final ITerm[] ZERO

A static zero-length array, created for convenience, and to save memory

NAME_PREFIX

static final String NAME_PREFIX

The name pattern for new objects of this type

See Also:

Constant Field Values

Method Detail

start

UTime start()

Returns the start time of the term

end

UTime end()

Returns the end time of the term

duration

UTime duration()

Returns the he duration of the term (= end - start)

start

void start(UTime s)

Sets the start time of the term

end

void end(UTime s)

Sets the end time of the term

appliesAt

boolean appliesAt(UTime t,
                  DayOfWeek day)

Returns true if the term matches time and day. Set Either time or day to null to mean "any"

day

DayOfWeek day()

Returns the day of the week for this term

day

void day(DayOfWeek day)

Sets the day of the week for this term