public interface CyclicTimePeriodQuery extends OsidObjectQuery
This is the query for searching cyclic time periods. 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 |
clearTimePeriodIdTerms()
Clears the cyclic time period
Id terms. |
void |
clearTimePeriodTerms()
Clears the time period terms.
|
CalendarQuery |
getCalendarQuery()
Gets the query for a calendar.
|
CyclicTimePeriodQueryRecord |
getCyclicTimePeriodQueryRecord(Type cyclicTimePeriodRecordType)
Gets the cyclic time period query record corresponding to the given
CyclicTimePeriod record Type. |
TimePeriodQuery |
getTimePeriodQuery()
Gets the query for a time period.
|
void |
matchAnyTimePeriod(boolean match)
Matches a cyclic time period that has any time period assigned.
|
void |
matchCalendarId(Id calendarId,
boolean match)
Sets the calendar
Id for this query. |
void |
matchTimePeriodId(Id timePeriodId,
boolean match)
Sets the time period
Id for this query to match cyclic
time periods with the given mapped time period. |
boolean |
supportsCalendarQuery()
Tests if a
CalendarQuery is available for querying
resources. |
boolean |
supportsTimePeriodQuery()
Tests if a
TimePeriodQuery is available for querying
time periods. |
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
void matchTimePeriodId(Id timePeriodId, boolean match)
Id
for this query to match cyclic
time periods with the given mapped time period.timePeriodId
- a tiem 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 for querying
time periods. 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 cyclic time periods with
any tiem period, false
to match cyclic time
periods with no tiem periodsmandatory
- This method must be implemented. void clearTimePeriodTerms()
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. CyclicTimePeriodQueryRecord getCyclicTimePeriodQueryRecord(Type cyclicTimePeriodRecordType) throws OperationFailedException
CyclicTimePeriod
record Type.
Multiple
retrievals produce a nested OR
term.cyclicTimePeriodRecordType
- a cyclic time period query record
typeNullArgumentException
-
cyclicTimePeriodRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(cyclicTimePeriodRecordType)
is
false
mandatory
- This method must be implemented.