Interface ScheduleSlotQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidContainableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

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 .

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidContainableQuery

clearSequesteredTerms, matchSequestered

Modifier and Type	Method	Description
void	clearSequesteredTerms()	Clears the sequestered query terms.
void	matchSequestered(boolean match)	Match containables that are sequestered.

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface OsidObjectQuery

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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

matchScheduleSlotId

void matchScheduleSlotId(Id scheduleSlotId,
 boolean match)

Sets the schedule Id for this query for matching nested schedule slots.

Parameters:

scheduleSlotId - a schedule slot Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - scheduleSlotId is null

Compliance:

mandatory - This method must be implemented.

clearScheduleSlotIdTerms

void clearScheduleSlotIdTerms()

Clears the schedule slot Id terms.

Compliance:

mandatory - This method must be implemented.

supportsScheduleSlotQuery

boolean supportsScheduleSlotQuery()

Tests if a ScheduleSlotQuery is available for querying sechedule slots.

Returns:

true if a schedule slot query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getScheduleSlotQuery

ScheduleSlotQuery getScheduleSlotQuery()

Gets the query for a schedul slot. Multiple retrievals produce a nested OR term.

Returns:

the schedule slot query

Throws:

UnimplementedException - supportsScheduleSlotQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsScheduleSlotQuery()} is {@code true} .

matchAnyScheduleSlot

void matchAnyScheduleSlot(boolean match)

Matches a schedule that has any schedule slot assigned.

Parameters:

match - true to match schedule with any schedule slots, false to match schedules with no schedule slots

Compliance:

mandatory - This method must be implemented.

clearScheduleSlotTerms

void clearScheduleSlotTerms()

Clears the schedule slot terms.

Compliance:

mandatory - This method must be implemented.

matchWeekday

void matchWeekday(long weekday,
 boolean match)

Matches schedules that have the given weekday.

Parameters:

weekday - a weekday

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

matchAnyWeekday

void matchAnyWeekday(boolean match)

Matches schedules with any weekday set.

Parameters:

match - true to match schedules with any weekday, false to match schedules with no weekday

Compliance:

mandatory - This method must be implemented.

clearWeekdayTerms

void clearWeekdayTerms()

Clears the weekday terms.

Compliance:

mandatory - This method must be implemented.

matchWeeklyInterval

void matchWeeklyInterval(long from,
 long to,
 boolean match)

Matches schedules that have the given weekly interval in the given range inclusive.

Parameters:

from - start range

to - end range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - to is less than from

Compliance:

mandatory - This method must be implemented.

matchAnyWeeklyInterval

void matchAnyWeeklyInterval(boolean match)

Matches schedules with any weekly interval set.

Parameters:

match - true to match schedules with any weekly interval, false to match schedules with no weekly interval

Compliance:

mandatory - This method must be implemented.

clearWeeklyIntervalTerms

void clearWeeklyIntervalTerms()

Clears the weekly interval terms.

Compliance:

mandatory - This method must be implemented.

matchWeekOfMonth

void matchWeekOfMonth(long from,
 long to,
 boolean match)

Matches schedules that have a week of month in the given range inclusive.

Parameters:

from - start range

to - end range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - to is less than from

Compliance:

mandatory - This method must be implemented.

matchAnyWeekOfMonth

void matchAnyWeekOfMonth(boolean match)

Matches schedules with any month week set.

Parameters:

match - true to match schedules with any week of month, false to match schedules with no month week

Compliance:

mandatory - This method must be implemented.

clearWeekOfMonthTerms

void clearWeekOfMonthTerms()

Clears the week of month terms.

Compliance:

mandatory - This method must be implemented.

matchWeekdayTime

void matchWeekdayTime(Time from,
 Time to,
 boolean match)

Matches schedules that have a weekday time in the given range inclusive.

Parameters:

from - start range

to - end range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - to is less than from

NullArgumentException - from or to null

Compliance:

mandatory - This method must be implemented.

matchAnyWeekdayTime

void matchAnyWeekdayTime(boolean match)

Matches schedules with any weekday time.

Parameters:

match - true to match schedules with any weekday time, false to match schedules with no weekday time

Compliance:

mandatory - This method must be implemented.

clearWeekdayTimeTerms

void clearWeekdayTimeTerms()

Clears the weekday time terms.

Compliance:

mandatory - This method must be implemented.

matchFixedInterval

void matchFixedInterval(Duration from,
 Duration to,
 boolean match)

Matches schedules that have the given fixed interval in the given range inclusive.

Parameters:

from - start range

to - end range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - to is less than from

NullArgumentException - from or to null

Compliance:

mandatory - This method must be implemented.

matchAnyFixedInterval

void matchAnyFixedInterval(boolean match)

Matches schedules with any fixed interval.

Parameters:

match - true to match schedules with any fixed interval, false to match schedules with no fixed interval

Compliance:

mandatory - This method must be implemented.

clearFixedIntervalTerms

void clearFixedIntervalTerms()

Clears the fixed interval terms.

Compliance:

mandatory - This method must be implemented.

matchDuration

void matchDuration(Duration low,
 Duration high,
 boolean match)

Matches the duration between the given range inclusive.

Parameters:

low - low duration range

high - high duration range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - high is less than low

NullArgumentException - high or low is null

Compliance:

mandatory - This method must be implemented.

matchAnyDuration

void matchAnyDuration(boolean match)

Matches a schedule slot that has any duration.

Parameters:

match - true to match schedules with any duration, false to match schedules with no start time

Compliance:

mandatory - This method must be implemented.

clearDurationTerms

void clearDurationTerms()

Clears the duration terms.

Compliance:

mandatory - This method must be implemented.

matchCalendarId

void matchCalendarId(Id calendarId,
 boolean match)

Sets the calendar Id for this query.

Parameters:

calendarId - a calendar Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - calendarId is null

Compliance:

mandatory - This method must be implemented.

clearCalendarIdTerms

void clearCalendarIdTerms()

Clears the calendar Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCalendarQuery

boolean supportsCalendarQuery()

Tests if a CalendarQuery is available for querying calendars.

Returns:

true if a calendar query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCalendarQuery

CalendarQuery getCalendarQuery()

Gets the query for a calendar. Multiple retrievals produce a nested OR term.

Returns:

the calendar query

Throws:

UnimplementedException - supportsCalendarQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCalendarQuery()} is {@code true} .

clearCalendarTerms

void clearCalendarTerms()

Clears the calendar terms.

Compliance:

mandatory - This method must be implemented.

getScheduleSlotQueryRecord

ScheduleSlotQueryRecord getScheduleSlotQueryRecord(Type scheduleSlotRecordType)
                                            throws OperationFailedException

Gets the schedule slot query record corresponding to the given ScheduleSlot record Type . Multiple retrievals produce a nested OR term.

Parameters:

scheduleSlotRecordType - a schedule slot query record type

Returns:

the schedule slot query record

Throws:

NullArgumentException - scheduleSlotRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(scheduleSlotRecordType) is false

Compliance:

mandatory - This method must be implemented.