org.osid.calendaring

Interface CalendarQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface CalendarQuery
extends OsidCatalogQuery

This is the query for searching calendars. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAncestorCalendarIdTerms() Clears the ancestor calendar Id terms.
void	clearAncestorCalendarTerms() Clears the ancestor calendar terms.
void	clearCommitmentIdTerms() Clears the commitment Id terms.
void	clearCommitmentTerms() Clears the commitment terms.
void	clearDescendantCalendarIdTerms() Clears the descendant calendar Id terms.
void	clearDescendantCalendarTerms() Clears the descendant calendar terms.
void	clearEventIdTerms() Clears the event Id terms.
void	clearEventTerms() Clears the event terms.
void	clearTimePeriodIdTerms() Clears the time period Id terms.
void	clearTimePeriodTerms() Clears the time period terms.
CalendarQuery	getAncestorCalendarQuery() Gets the query for a calendar.
CalendarQueryRecord	getCalendarQueryRecord(Type calendarRecordType) Gets the calendar query record corresponding to the given Calendar record Type.
CommitmentQuery	getCommitmentQuery() Gets the query for a commitment.
CalendarQuery	getDescendantCalendarQuery() Gets the query for a calendar.
EventQuery	getEventQuery() Gets the query for an event.
TimePeriodQuery	getTimePeriodQuery() Gets the query for a time period.
void	matchAncestorCalendarId(Id calendarId, boolean match) Sets the calendar Id for this query to match calendars that have the specified calendar as an ancestor.
void	matchAnyAncestorCalendar(boolean match) Matches a calendar that has any ancestor.
void	matchAnyCommitment(boolean match) Matches a calendar that has any event commitment.
void	matchAnyDescendantCalendar(boolean match) Matches a calendar that has any descendant.
void	matchAnyEvent(boolean match) Matches a calendar that has any event assigned.
void	matchAnyTimePeriod(boolean match) Matches a calendar that has any time period assigned.
void	matchCommitmentId(Id commitmentId, boolean match) Sets the commitment Id for this query.
void	matchDescendantCalendarId(Id calendarId, boolean match) Sets the calendar Id for this query to match calendars that have the specified calendar as a descendant.
void	matchEventId(Id eventId, boolean match) Sets the event Id for this query.
void	matchTimePeriodId(Id timePeriodId, boolean match) Sets the time period Id for this query.
boolean	supportsAncestorCalendarQuery() Tests if a CalendarQuery is available.
boolean	supportsCommitmentQuery() Tests if a CommitmentQuery is available.
boolean	supportsDescendantCalendarQuery() Tests if a CalendarQuery.
boolean	supportsEventQuery() Tests if an EventQuery is available.
boolean	supportsTimePeriodQuery() Tests if a TimePeriodQuery is available.

Methods inherited from interface org.osid.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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchEventId

void matchEventId(Id eventId,
                boolean match)

Sets the event Id for this query.

Parameters:

eventId - an 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.

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. Multiple retrievals produce a nested OR term.

Returns:

the event query

Throws:

UnimplementedException - supportsEventQuery() is false

Compliance:

optional - This method must be implemented if supportsEventQuery() is true.

matchAnyEvent

void matchAnyEvent(boolean match)

Matches a calendar that has any event assigned.

Parameters:

match - true to match calendars with any event, false to match calendars with no events

Compliance:

mandatory - This method must be implemented.

clearEventTerms

void clearEventTerms()

Clears the event terms.

Compliance:

mandatory - This method must be implemented.

matchTimePeriodId

void matchTimePeriodId(Id timePeriodId,
                     boolean match)

Sets the time period Id for this query.

Parameters:

timePeriodId - a time period Id

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

Throws:

NullArgumentException - timePeriodId is null

Compliance:

mandatory - This method must be implemented.

clearTimePeriodIdTerms

void clearTimePeriodIdTerms()

Clears the time period Id terms.

Compliance:

mandatory - This method must be implemented.

supportsTimePeriodQuery

boolean supportsTimePeriodQuery()

Tests if a TimePeriodQuery is available.

Returns:

true if a time period query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTimePeriodQuery

TimePeriodQuery getTimePeriodQuery()

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

Returns:

the tiem period query

Throws:

UnimplementedException - supportsTimePeriodQuery() is false

Compliance:

optional - This method must be implemented if supportsTimePeriodQuery() is true.

matchAnyTimePeriod

void matchAnyTimePeriod(boolean match)

Matches a calendar that has any time period assigned.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearTimePeriodTerms

void clearTimePeriodTerms()

Clears the time period terms.

Compliance:

mandatory - This method must be implemented.

matchCommitmentId

void matchCommitmentId(Id commitmentId,
                     boolean match)

Sets the commitment Id for this query.

Parameters:

commitmentId - a commitment Id

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

Throws:

NullArgumentException - commitmentId is null

Compliance:

mandatory - This method must be implemented.

clearCommitmentIdTerms

void clearCommitmentIdTerms()

Clears the commitment Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCommitmentQuery

boolean supportsCommitmentQuery()

Tests if a CommitmentQuery is available.

Returns:

true if a commitment query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCommitmentQuery

CommitmentQuery getCommitmentQuery()

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

Returns:

the commitment query

Throws:

UnimplementedException - supportsCommitmentQuery() is false

Compliance:

optional - This method must be implemented if supportsCommitmentQuery() is true.

matchAnyCommitment

void matchAnyCommitment(boolean match)

Matches a calendar that has any event commitment.

Parameters:

match - true to match calendars with any commitment, false to match calendars with no commitments

Compliance:

mandatory - This method must be implemented.

clearCommitmentTerms

void clearCommitmentTerms()

Clears the commitment terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorCalendarId

void matchAncestorCalendarId(Id calendarId,
                           boolean match)

Sets the calendar Id for this query to match calendars that have the specified calendar as an ancestor.

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.

clearAncestorCalendarIdTerms

void clearAncestorCalendarIdTerms()

Clears the ancestor calendar Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorCalendarQuery

boolean supportsAncestorCalendarQuery()

Tests if a CalendarQuery is available.

Returns:

true if a calendar query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorCalendarQuery

CalendarQuery getAncestorCalendarQuery()

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

Returns:

the calendar query

Throws:

UnimplementedException - supportsAncestorCalendarQuery() is false

Compliance:

optional - This method must be implemented if supportsAncestorCalndarQuery() is true.

matchAnyAncestorCalendar

void matchAnyAncestorCalendar(boolean match)

Matches a calendar that has any ancestor.

Parameters:

match - true to match calendars with any ancestor, false to match root calendars

Compliance:

mandatory - This method must be implemented.

clearAncestorCalendarTerms

void clearAncestorCalendarTerms()

Clears the ancestor calendar terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantCalendarId

void matchDescendantCalendarId(Id calendarId,
                             boolean match)

Sets the calendar Id for this query to match calendars that have the specified calendar as a descendant.

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.

clearDescendantCalendarIdTerms

void clearDescendantCalendarIdTerms()

Clears the descendant calendar Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantCalendarQuery

boolean supportsDescendantCalendarQuery()

Tests if a CalendarQuery.

Returns:

true if a calendar query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantCalendarQuery

CalendarQuery getDescendantCalendarQuery()

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

Returns:

the calendar query

Throws:

UnimplementedException - supportsDescendantCalendarQuery() is false

Compliance:

optional - This method must be implemented if supportsDescendantCalndarQuery() is true.

matchAnyDescendantCalendar

void matchAnyDescendantCalendar(boolean match)

Matches a calendar that has any descendant.

Parameters:

match - true to match calendars with any descendant, false to match leaf calendars

Compliance:

mandatory - This method must be implemented.

clearDescendantCalendarTerms

void clearDescendantCalendarTerms()

Clears the descendant calendar terms.

Compliance:

mandatory - This method must be implemented.

getCalendarQueryRecord

CalendarQueryRecord getCalendarQueryRecord(Type calendarRecordType)
                                           throws OperationFailedException

Gets the calendar query record corresponding to the given Calendar record Type. Multiple record retrievals produce a nested OR term.

Parameters:

calendarRecordType - a calendar record type

Returns:

the calendar query record

Throws:

NullArgumentException - calendarRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(calendarRecordType) is false

Compliance:

mandatory - This method must be implemented.