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.
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. |
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
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
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 matchAnyEvent(boolean match)
match
- true
to match calendars with any event,
false
to match calendars with no eventsmandatory
- This method must be implemented. void clearEventTerms()
mandatory
- This method must be implemented. void matchTimePeriodId(Id timePeriodId, boolean match)
Id
for this query.timePeriodId
- a time period Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- timePeriodId
is
null
mandatory
- This method must be implemented. void clearTimePeriodIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsTimePeriodQuery()
TimePeriodQuery
is available. true
if a time period query is available,
false
otherwisemandatory
- This method must be implemented. TimePeriodQuery getTimePeriodQuery()
OR
term.UnimplementedException
-
supportsTimePeriodQuery()
is false
optional
- This method must be implemented if
supportsTimePeriodQuery()
is true.
void matchAnyTimePeriod(boolean match)
match
- true
to match calendars with any time
period, false
to match calendars with no time
periodsmandatory
- This method must be implemented. void clearTimePeriodTerms()
mandatory
- This method must be implemented. void matchCommitmentId(Id commitmentId, boolean match)
Id
for this query.commitmentId
- a commitment Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- commitmentId
is
null
mandatory
- This method must be implemented. void clearCommitmentIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCommitmentQuery()
CommitmentQuery
is available. true
if a commitment query is available,
false
otherwisemandatory
- This method must be implemented. CommitmentQuery getCommitmentQuery()
OR
term.UnimplementedException
-
supportsCommitmentQuery()
is false
optional
- This method must be implemented if
supportsCommitmentQuery()
is true.
void matchAnyCommitment(boolean match)
match
- true
to match calendars with any
commitment, false
to match calendars with no
commitmentsmandatory
- This method must be implemented. void clearCommitmentTerms()
mandatory
- This method must be implemented. void matchAncestorCalendarId(Id calendarId, boolean match)
Id
for this query to match calendars
that have the specified calendar as an ancestor.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 clearAncestorCalendarIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorCalendarQuery()
CalendarQuery
is available. true
if a calendar query is available,
false
otherwisemandatory
- This method must be implemented. CalendarQuery getAncestorCalendarQuery()
OR
term.UnimplementedException
-
supportsAncestorCalendarQuery()
is false
optional
- This method must be implemented if
supportsAncestorCalndarQuery()
is true.
void matchAnyAncestorCalendar(boolean match)
match
- true
to match calendars with any
ancestor, false
to match root calendarsmandatory
- This method must be implemented. void clearAncestorCalendarTerms()
mandatory
- This method must be implemented. void matchDescendantCalendarId(Id calendarId, boolean match)
Id
for this query to match calendars
that have the specified calendar as a descendant.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 clearDescendantCalendarIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantCalendarQuery()
CalendarQuery.
true
if a calendar query is available,
false
otherwisemandatory
- This method must be implemented. CalendarQuery getDescendantCalendarQuery()
OR
term.UnimplementedException
-
supportsDescendantCalendarQuery()
is false
optional
- This method must be implemented if
supportsDescendantCalndarQuery()
is true.
void matchAnyDescendantCalendar(boolean match)
match
- true
to match calendars with any
descendant, false
to match leaf calendarsmandatory
- This method must be implemented. void clearDescendantCalendarTerms()
mandatory
- This method must be implemented. CalendarQueryRecord getCalendarQueryRecord(Type calendarRecordType) throws OperationFailedException
Calendar
record Type.
Multiple record
retrievals produce a nested OR
term.calendarRecordType
- a calendar record typeNullArgumentException
- calendarRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(calendarRecordType)
is false
mandatory
- This method must be implemented.