org.osid.calendaring

Interface CommitmentQuery

All Superinterfaces:

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

public interface CommitmentQuery
extends OsidRelationshipQuery

This is the query for searching commitments. Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCalendarIdTerms() Clears the calendar Id terms.
void	clearCalendarTerms() Clears the calendar terms.
void	clearEventIdTerms() Clears the event Id terms.
void	clearEventTerms() Clears the event terms.
void	clearResourceIdTerms() Clears the resource Id terms.
void	clearResourceTerms() Clears the resource terms.
CalendarQuery	getCalendarQuery() Gets the query for a calendar.
CommitmentQueryRecord	getCommitmentQueryRecord(Type commitmentRecordType) Gets the commitment query record corresponding to the given Commitment record Type.
EventQuery	getEventQuery() Gets the query for an event.
ResourceQuery	getResourceQuery() Gets the query for a resource.
void	matchCalendarId(Id calendarId, boolean match) Sets the calendar Id for this query.
void	matchEventId(Id eventId, boolean match) Sets the event Id for this query.
void	matchResourceId(Id resourceId, boolean match) Sets the resource Id for this query.
boolean	supportsCalendarQuery() Tests if a CalendarQuery is available for querying resources.
boolean	supportsEventQuery() Tests if an EventQuery is available.
boolean	supportsResourceQuery() Tests if a ResourceQuery is available for querying resources.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

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

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

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.

clearEventTerms

void clearEventTerms()

Clears the event terms.

Compliance:

mandatory - This method must be implemented.

matchResourceId

void matchResourceId(Id resourceId,
                   boolean match)

Sets the resource Id for this query.

Parameters:

resourceId - a resource Id

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

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearResourceIdTerms

void clearResourceIdTerms()

Clears the resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsResourceQuery

boolean supportsResourceQuery()

Tests if a ResourceQuery is available for querying resources.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceQuery

ResourceQuery getResourceQuery()

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

Returns:

the resource query

Throws:

UnimplementedException - supportsResourceQuery() is false

Compliance:

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

clearResourceTerms

void clearResourceTerms()

Clears the resource 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 supportsCalendarQuery() is true.

clearCalendarTerms

void clearCalendarTerms()

Clears the calendar terms.

Compliance:

mandatory - This method must be implemented.

getCommitmentQueryRecord

CommitmentQueryRecord getCommitmentQueryRecord(Type commitmentRecordType)
                                               throws OperationFailedException

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

Parameters:

commitmentRecordType - a commitment query record type

Returns:

the commitment query record

Throws:

NullArgumentException - commitmentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commitmentRecordType) is false

Compliance:

mandatory - This method must be implemented.