public interface ScheduleQuery extends OsidObjectQuery
This is the query for searching schedules. 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 |
clearLimitTerms()
Clears the limit terms.
|
void |
clearLocationDescriptionTerms()
Clears the location description terms.
|
void |
clearLocationIdTerms()
Clears the location
Id terms. |
void |
clearLocationTerms()
Clears the location terms.
|
void |
clearScheduleEndTerms()
Clears the schedule end terms.
|
void |
clearScheduleSlotIdTerms()
Clears the schedule slot
Id terms. |
void |
clearScheduleSlotTerms()
Clears the schedule slot terms.
|
void |
clearScheduleStartTerms()
Clears the schedule start terms.
|
void |
clearScheduleTimeInclusiveTerms()
Clears the schedule time inclusive terms.
|
void |
clearScheduleTimeTerms()
Clears the schedule time terms.
|
void |
clearTimePeriodIdTerms()
Clears the time period
Id terms. |
void |
clearTimePeriodTerms()
Clears the time period terms.
|
void |
clearTotalDurationTerms()
Clears the total duration terms.
|
CalendarQuery |
getCalendarQuery()
Gets the query for a calendar.
|
LocationQuery |
getLocationQuery()
Gets the query for a location.
|
ScheduleQueryRecord |
getScheduleQueryRecord(Type scheduleRecordType)
Gets the schedule query record corresponding to the given
Schedule record Type. |
ScheduleSlotQuery |
getScheduleSlotQuery()
Gets the query for a schedul slot.
|
TimePeriodQuery |
getTimePeriodQuery()
Gets the query for a time period.
|
void |
matchAnyLimit(boolean match)
Matches schedules with any occurrence limit.
|
void |
matchAnyLocation(boolean match)
Matches a schedule that has any location assigned.
|
void |
matchAnyLocationDescription(boolean match)
Matches a schedule that has any location description assigned.
|
void |
matchAnyScheduleEnd(boolean match)
Matches a schedule that has any end time assigned.
|
void |
matchAnyScheduleSlot(boolean match)
Matches a schedule that has any schedule slot assigned.
|
void |
matchAnyScheduleStart(boolean match)
Matches a schedule that has any start time assigned.
|
void |
matchAnyScheduleTime(boolean match)
Matches schedules that has any time assigned.
|
void |
matchAnyTimePeriod(boolean match)
Matches a schedule that has any time period assigned.
|
void |
matchCalendarId(Id calendarId,
boolean match)
Sets the calendar
Id for this query. |
void |
matchLimit(long from,
long to,
boolean match)
Matches schedules that have the given limit in the given range
inclusive.
|
void |
matchLocationDescription(java.lang.String location,
Type stringMatchType,
boolean match)
Matches the location description string.
|
void |
matchLocationId(Id locationId,
boolean match)
Sets the location
Id for this query. |
void |
matchScheduleEnd(DateTime low,
DateTime high,
boolean match)
Matches the schedule end time between the given range inclusive.
|
void |
matchScheduleSlotId(Id scheduleSlotId,
boolean match)
Sets the schedule
Id for this query for matching nested
schedule slots. |
void |
matchScheduleStart(DateTime low,
DateTime high,
boolean match)
Matches the schedule start time between the given range inclusive.
|
void |
matchScheduleTime(DateTime date,
boolean match)
Matches schedules with start and end times between the given range
inclusive.
|
void |
matchScheduleTimeInclusive(DateTime start,
DateTime end,
boolean match)
Matches schedules with start and end times between the given range
inclusive.
|
void |
matchTimePeriodId(Id timePeriodId,
boolean match)
Sets the time period
Id for this query. |
void |
matchTotalDuration(Duration low,
Duration high,
boolean match)
Matches the total duration between the given range inclusive.
|
boolean |
supportsCalendarQuery()
Tests if a
CalendarQuery is available for querying
calendars. |
boolean |
supportsLocationQuery()
Tests if a
LocationQuery is available for querying
locations. |
boolean |
supportsScheduleSlotQuery()
Tests if a
ScheduleSlotQuery is available for querying
sechedule slots. |
boolean |
supportsTimePeriodQuery()
Tests if a
TimePeriodQuery is available. |
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
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 matchTimePeriodId(Id timePeriodId, boolean match)
Id
for this query.timePeriodId
- a time period Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- timePeriodId
is
null
mandatory
- This method must be implemented. void clearTimePeriodIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsTimePeriodQuery()
TimePeriodQuery
is available. true
if a time period query is available,
false
otherwisemandatory
- This method must be implemented. TimePeriodQuery getTimePeriodQuery()
OR
term.UnimplementedException
-
supportsTimePeriodQuery()
is false
optional
- This method must be implemented if
supportsTimePeriodQuery()
is true.
void matchAnyTimePeriod(boolean match)
match
- true
to match schedules with any time
periods, false
to match schedules with no time
periodsmandatory
- This method must be implemented. void clearTimePeriodTerms()
mandatory
- This method must be implemented. void matchScheduleStart(DateTime low, DateTime high, boolean match)
low
- low time rangehigh
- high time 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 matchAnyScheduleStart(boolean match)
match
- true
to match schedules with any start
time, false
to match schedules with no start
timemandatory
- This method must be implemented. void clearScheduleStartTerms()
mandatory
- This method must be implemented. void matchScheduleEnd(DateTime low, DateTime high, boolean match)
low
- low time rangehigh
- high time 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 matchAnyScheduleEnd(boolean match)
match
- true
to match schedules with any end
time, false
to match schedules with no start
timemandatory
- This method must be implemented. void clearScheduleEndTerms()
mandatory
- This method must be implemented. void matchScheduleTime(DateTime date, boolean match)
date
- a datematch
- true
for a positive match, false
for a negative matchNullArgumentException
- date
is
null
mandatory
- This method must be implemented. void matchAnyScheduleTime(boolean match)
match
- true
to match schedules with any time,
false
to match schedules with no timemandatory
- This method must be implemented. void clearScheduleTimeTerms()
mandatory
- This method must be implemented. void matchScheduleTimeInclusive(DateTime start, DateTime end, boolean match)
start
- start dateend
- end datematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- end
is less
than start
NullArgumentException
- end
or
start
is null
mandatory
- This method must be implemented. void clearScheduleTimeInclusiveTerms()
mandatory
- This method must be implemented. void matchLimit(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 matchAnyLimit(boolean match)
match
- true
to match schedules with any limit,
to match schedules with no limitmandatory
- This method must be implemented. void clearLimitTerms()
mandatory
- This method must be implemented. void matchLocationDescription(java.lang.String location, Type stringMatchType, boolean match)
location
- location stringstringMatchType
- string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- location
is
not of stringMatchType
NullArgumentException
- location
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyLocationDescription(boolean match)
match
- true
to match schedules with any location
description, false
to match schedules with no
location descriptionmandatory
- This method must be implemented. void clearLocationDescriptionTerms()
mandatory
- This method must be implemented. void matchLocationId(Id locationId, boolean match)
Id
for this query.locationId
- a location Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- locationId
is
null
mandatory
- This method must be implemented. void clearLocationIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsLocationQuery()
LocationQuery
is available for querying
locations. true
if a location query is available,
false
otherwisemandatory
- This method must be implemented. LocationQuery getLocationQuery()
OR
term.UnimplementedException
- supportsLocationQuery()
is false
optional
- This method must be implemented if
supportsLocationQuery()
is true.
void matchAnyLocation(boolean match)
match
- true
to match schedules with any
location, false
to match schedules with no
locationmandatory
- This method must be implemented. void clearLocationTerms()
mandatory
- This method must be implemented. void matchTotalDuration(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 clearTotalDurationTerms()
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. ScheduleQueryRecord getScheduleQueryRecord(Type scheduleRecordType) throws OperationFailedException
Schedule
record Type.
Multiple retrievals
produce a nested OR
term.scheduleRecordType
- a schedule query record typeNullArgumentException
- scheduleRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(scheduleRecordType)
is false
mandatory
- This method must be implemented.