Interface TimePeriodQuery

All Superinterfaces:

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

public interface TimePeriodQuery
extends OsidObjectQuery

This is the query for searching time periods. 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	clearEndTerms()	Clears the time period end terms.
void	clearEventIdTerms()	Clears the event Id terms.
void	clearEventTerms()	Clears the event terms.
void	clearExceptionIdTerms()	Clears the exception event Id terms.
void	clearExceptionTerms()	Clears the exception event terms.
void	clearStartTerms()	Clears the time period start terms.
void	clearTimeInclusiveTerms()	Clears the time inclusive terms.
void	clearTimeTerms()	Clears the time terms.
CalendarQuery	getCalendarQuery()	Gets the query for a calendar.
EventQuery	getEventQuery()	Gets the query for an event or recurring event.
EventQuery	getExceptionQuery()	Gets the query for an exception event.
TimePeriodQueryRecord	getTimePeriodQueryRecord(Type timePeriodRecordType)	Gets the time period query record corresponding to the given TimePeriod record Type .
void	matchAnyEnd(boolean match)	Matches a time period that has any end time assigned.
void	matchAnyEvent(boolean match)	Matches a time period that has any event assigned.
void	matchAnyException(boolean match)	Matches a time period that has any exception event assigned.
void	matchAnyStart(boolean match)	Matches a time period that has any start time assigned.
void	matchAnyTime(boolean match)	Matches a time period that has any time assigned.
void	matchCalendarId(Id calendarId, boolean match)	Sets the calendar Id for this query.
void	matchDuration(Duration low, Duration high, boolean match)	Matches the time period duration between the given range inclusive.
void	matchEnd(DateTime low, DateTime high, boolean match)	Matches the time period end time between the given range inclusive.
void	matchEventId(Id eventId, boolean match)	Sets the event Id for this query.
void	matchExceptionId(Id eventId, boolean match)	Sets the event Id for this query to match exceptions.
void	matchStart(DateTime low, DateTime high, boolean match)	Matches the time period start time between the given range inclusive.
void	matchTime(DateTime time, boolean match)	Matches time periods that include the given time.
void	matchTimeInclusive(DateTime start, DateTime end, boolean match)	Matches time periods with start and end times between the given range inclusive.
boolean	supportsCalendarQuery()	Tests if a CalendarQuery is available for querying resources.
boolean	supportsEventQuery()	Tests if an EventQuery is available for querying events.
boolean	supportsExceptionQuery()	Tests if an EventQuery is available for querying exception events.

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 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

matchStart

void matchStart(DateTime low,
 DateTime high,
 boolean match)

Matches the time period start time between the given range inclusive.

Parameters:

low - low time range

high - high time range

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

Throws:

InvalidArgumentException - high is less than low

NullArgumentException - high or low is zero

Compliance:

mandatory - This method must be implemented.

matchAnyStart

void matchAnyStart(boolean match)

Matches a time period that has any start time assigned.

Parameters:

match - true to match time periods with any start time, false to match time periods with no start time

Compliance:

mandatory - This method must be implemented.

clearStartTerms

void clearStartTerms()

Clears the time period start terms.

Compliance:

mandatory - This method must be implemented.

matchEnd

void matchEnd(DateTime low,
 DateTime high,
 boolean match)

Matches the time period end time between the given range inclusive.

Parameters:

low - low time range

high - high time range

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

Throws:

InvalidArgumentException - high is less than low

NullArgumentException - high or low is zero

Compliance:

mandatory - This method must be implemented.

matchAnyEnd

void matchAnyEnd(boolean match)

Matches a time period that has any end time assigned.

Parameters:

match - true to match time periods with any end time, false to match time periods with no end time

Compliance:

mandatory - This method must be implemented.

clearEndTerms

void clearEndTerms()

Clears the time period end terms.

Compliance:

mandatory - This method must be implemented.

matchTime

void matchTime(DateTime time,
 boolean match)

Matches time periods that include the given time.

Parameters:

time - date

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

Compliance:

mandatory - This method must be implemented.

matchAnyTime

void matchAnyTime(boolean match)

Matches a time period that has any time assigned.

Parameters:

match - true to match time periods with any time, false to match time periods with no time

Compliance:

mandatory - This method must be implemented.

clearTimeTerms

void clearTimeTerms()

Clears the time terms.

Compliance:

mandatory - This method must be implemented.

matchTimeInclusive

void matchTimeInclusive(DateTime start,
 DateTime end,
 boolean match)

Matches time periods with start and end times between the given range inclusive.

Parameters:

start - start date

end - end date

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

Throws:

InvalidArgumentException - end is less than start

NullArgumentException - start or end is zero

Compliance:

mandatory - This method must be implemented.

clearTimeInclusiveTerms

void clearTimeInclusiveTerms()

Clears the time inclusive terms.

Compliance:

mandatory - This method must be implemented.

matchDuration

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

Matches the time period 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.

clearDurationTerms

void clearDurationTerms()

Clears the duration terms.

Compliance:

mandatory - This method must be implemented.

matchExceptionId

void matchExceptionId(Id eventId,
 boolean match)

Sets the event Id for this query to match exceptions.

Parameters:

eventId - an exception event Id

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

Throws:

NullArgumentException - eventId is null

Compliance:

mandatory - This method must be implemented.

clearExceptionIdTerms

void clearExceptionIdTerms()

Clears the exception event Id terms.

Compliance:

mandatory - This method must be implemented.

supportsExceptionQuery

boolean supportsExceptionQuery()

Tests if an EventQuery is available for querying exception events.

Returns:

true if an exception query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getExceptionQuery

EventQuery getExceptionQuery()

Gets the query for an exception event. Multiple retrievals produce a nested OR term.

Returns:

the event query

Throws:

UnimplementedException - supportsExceptionQuery() is false

Compliance:

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

matchAnyException

void matchAnyException(boolean match)

Matches a time period that has any exception event assigned.

Parameters:

match - true to match time periods with any exception, false to match time periods with no exception

Compliance:

mandatory - This method must be implemented.

clearExceptionTerms

void clearExceptionTerms()

Clears the exception event terms.

Compliance:

mandatory - This method must be implemented.

matchEventId

void matchEventId(Id eventId,
 boolean match)

Sets the event Id for this query.

Parameters:

eventId - an event or recurring event Id

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

Throws:

NullArgumentException - eventId is null

Compliance:

mandatory - This method must be implemented.

clearEventIdTerms

void clearEventIdTerms()

Clears the event Id terms.

Compliance:

mandatory - This method must be implemented.

supportsEventQuery

boolean supportsEventQuery()

Tests if an EventQuery is available for querying events.

Returns:

true if an event query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEventQuery

EventQuery getEventQuery()

Gets the query for an event or recurring event. Multiple retrievals produce a nested OR term.

Returns:

the event query

Throws:

UnimplementedException - supportsEventQuery() is false

Compliance:

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

matchAnyEvent

void matchAnyEvent(boolean match)

Matches a time period that has any event assigned.

Parameters:

match - true to match time periods with any event, false to match time periods with no events

Compliance:

mandatory - This method must be implemented.

clearEventTerms

void clearEventTerms()

Clears the event 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 resources.

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.

getTimePeriodQueryRecord

TimePeriodQueryRecord getTimePeriodQueryRecord(Type timePeriodRecordType)
                                        throws OperationFailedException

Gets the time period query record corresponding to the given TimePeriod record Type . Multiple retrievals produce a nested OR term.

Parameters:

timePeriodRecordType - a time period query record type

Returns:

the time period query record

Throws:

NullArgumentException - timePeriodRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(timePeriodRecordType) is false

Compliance:

mandatory - This method must be implemented.