public interface ScheduleSlotQuery extends OsidObjectQuery, OsidContainableQuery
This is the query for searching schedule slots. Each method match
request produces an AND
term while multiple invocations of
a method produces a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearCalendarIdTerms()
Clears the calendar
Id terms. |
void |
clearCalendarTerms()
Clears the calendar terms.
|
void |
clearDurationTerms()
Clears the duration terms.
|
void |
clearFixedIntervalTerms()
Clears the fixed interval terms.
|
void |
clearScheduleSlotIdTerms()
Clears the schedule slot
Id terms. |
void |
clearScheduleSlotTerms()
Clears the schedule slot terms.
|
void |
clearWeekdayTerms()
Clears the weekday terms.
|
void |
clearWeekdayTimeTerms()
Clears the weekday time terms.
|
void |
clearWeeklyIntervalTerms()
Clears the weekly interval terms.
|
void |
clearWeekOfMonthTerms()
Clears the week of month terms.
|
CalendarQuery |
getCalendarQuery()
Gets the query for a calendar.
|
ScheduleSlotQuery |
getScheduleSlotQuery()
Gets the query for a schedul slot.
|
ScheduleSlotQueryRecord |
getScheduleSlotQueryRecord(Type scheduleSlotRecordType)
Gets the schedule slot query record corresponding to the given
ScheduleSlot record Type. |
void |
matchAnyDuration(boolean match)
Matches a schedule slot that has any duration.
|
void |
matchAnyFixedInterval(boolean match)
Matches schedules with any fixed interval.
|
void |
matchAnyScheduleSlot(boolean match)
Matches a schedule that has any schedule slot assigned.
|
void |
matchAnyWeekday(boolean match)
Matches schedules with any weekday set.
|
void |
matchAnyWeekdayTime(boolean match)
Matches schedules with any weekday time.
|
void |
matchAnyWeeklyInterval(boolean match)
Matches schedules with any weekly interval set.
|
void |
matchAnyWeekOfMonth(boolean match)
Matches schedules with any month week set.
|
void |
matchCalendarId(Id calendarId,
boolean match)
Sets the calendar
Id for this query. |
void |
matchDuration(Duration low,
Duration high,
boolean match)
Matches the duration between the given range inclusive.
|
void |
matchFixedInterval(Duration from,
Duration to,
boolean match)
Matches schedules that have the given fixed interval in the given
range inclusive.
|
void |
matchScheduleSlotId(Id scheduleSlotId,
boolean match)
Sets the schedule
Id for this query for matching nested
schedule slots. |
void |
matchWeekday(long weekday,
boolean match)
Matches schedules that have the given weekday.
|
void |
matchWeekdayTime(Time from,
Time to,
boolean match)
Matches schedules that have a weekday time in the given range
inclusive.
|
void |
matchWeeklyInterval(long from,
long to,
boolean match)
Matches schedules that have the given weekly interval in the given
range inclusive.
|
void |
matchWeekOfMonth(long from,
long to,
boolean match)
Matches schedules that have a week of month in the given range
inclusive.
|
boolean |
supportsCalendarQuery()
Tests if a
CalendarQuery is available for querying
calendars. |
boolean |
supportsScheduleSlotQuery()
Tests if a
ScheduleSlotQuery is available for querying
sechedule slots. |
clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearSequesteredTerms, matchSequestered
void matchScheduleSlotId(Id scheduleSlotId, boolean match)
Id
for this query for matching nested
schedule slots.scheduleSlotId
- a schedule slot Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- scheduleSlotId
is null
mandatory
- This method must be implemented. void clearScheduleSlotIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsScheduleSlotQuery()
ScheduleSlotQuery
is available for querying
sechedule slots. true
if a schedule slot query is available,
false
otherwisemandatory
- This method must be implemented. ScheduleSlotQuery getScheduleSlotQuery()
OR
term.UnimplementedException
-
supportsScheduleSlotQuery()
is false
optional
- This method must be implemented if
supportsScheduleSlotQuery()
is true.
void matchAnyScheduleSlot(boolean match)
match
- true
to match schedule with any schedule
slots, false
to match schedules with no
schedule slotsmandatory
- This method must be implemented. void clearScheduleSlotTerms()
mandatory
- This method must be implemented. void matchWeekday(long weekday, boolean match)
weekday
- a weekdaymatch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void matchAnyWeekday(boolean match)
match
- true
to match schedules with any weekday,
false
to match schedules with no weekdaymandatory
- This method must be implemented. void clearWeekdayTerms()
mandatory
- This method must be implemented. void matchWeeklyInterval(long from, long to, boolean match)
from
- start rangeto
- end rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- to
is less
than from
mandatory
- This method must be implemented. void matchAnyWeeklyInterval(boolean match)
match
- true
to match schedules with any weekly
interval, false
to match schedules with no
weekly intervalmandatory
- This method must be implemented. void clearWeeklyIntervalTerms()
mandatory
- This method must be implemented. void matchWeekOfMonth(long from, long to, boolean match)
from
- start rangeto
- end rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- to
is less
than from
mandatory
- This method must be implemented. void matchAnyWeekOfMonth(boolean match)
match
- true
to match schedules with any week of
month, false
to match schedules with no month
weekmandatory
- This method must be implemented. void clearWeekOfMonthTerms()
mandatory
- This method must be implemented. void matchWeekdayTime(Time from, Time to, boolean match)
from
- start rangeto
- end rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- to
is less
than from
NullArgumentException
- from
or
to
null
mandatory
- This method must be implemented. void matchAnyWeekdayTime(boolean match)
match
- true
to match schedules with any weekday
time, false
to match schedules with no weekday
timemandatory
- This method must be implemented. void clearWeekdayTimeTerms()
mandatory
- This method must be implemented. void matchFixedInterval(Duration from, Duration to, boolean match)
from
- start rangeto
- end rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- to
is less
than from
NullArgumentException
- from
or
to
null
mandatory
- This method must be implemented. void matchAnyFixedInterval(boolean match)
match
- true
to match schedules with any fixed
interval, false
to match schedules with no
fixed intervalmandatory
- This method must be implemented. void clearFixedIntervalTerms()
mandatory
- This method must be implemented. void matchDuration(Duration low, Duration high, boolean match)
low
- low duration rangehigh
- high duration rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
NullArgumentException
- high
or
low
is null
mandatory
- This method must be implemented. void matchAnyDuration(boolean match)
match
- true
to match schedules with any
duration, false
to match schedules with no
start timemandatory
- This method must be implemented. void clearDurationTerms()
mandatory
- This method must be implemented. void matchCalendarId(Id calendarId, boolean match)
Id
for this query.calendarId
- a calendar Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- calendarId
is
null
mandatory
- This method must be implemented. void clearCalendarIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCalendarQuery()
CalendarQuery
is available for querying
calendars. true
if a calendar query is available,
false
otherwisemandatory
- This method must be implemented. CalendarQuery getCalendarQuery()
OR
term.UnimplementedException
- supportsCalendarQuery()
is false
optional
- This method must be implemented if
supportsCalendarQuery()
is true.
void clearCalendarTerms()
mandatory
- This method must be implemented. ScheduleSlotQueryRecord getScheduleSlotQueryRecord(Type scheduleSlotRecordType) throws OperationFailedException
ScheduleSlot
record Type.
Multiple retrievals
produce a nested OR
term.scheduleSlotRecordType
- a schedule slot query record typeNullArgumentException
- scheduleSlotRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(scheduleSlotRecordType)
is false
mandatory
- This method must be implemented.