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.
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. |
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchEventId(Id eventId, boolean match)
Id
for this query.eventId
- an event Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- eventId
is
null
mandatory
- This method must be implemented. void clearEventIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsEventQuery()
EventQuery
is available. true
if an event query is available,
false
otherwisemandatory
- This method must be implemented. EventQuery getEventQuery()
OR
term.UnimplementedException
- supportsEventQuery()
is false
optional
- This method must be implemented if
supportsEventQuery()
is true.
void clearEventTerms()
mandatory
- This method must be implemented. void matchResourceId(Id resourceId, boolean match)
Id
for this query.resourceId
- a resource Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearResourceIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsResourceQuery()
ResourceQuery
is available for querying
resources. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getResourceQuery()
OR
term.UnimplementedException
- supportsResourceQuery()
is false
optional
- This method must be implemented if
supportsResourceQuery()
is true.
void clearResourceTerms()
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
resources. 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. CommitmentQueryRecord getCommitmentQueryRecord(Type commitmentRecordType) throws OperationFailedException
Commitment
record Type.
Multiple retrievals
produce a nested OR
term.commitmentRecordType
- a commitment query record typeNullArgumentException
- commitmentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(commitmentRecordType)
is false
mandatory
- This method must be implemented.