Interface RecurringEventQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidContainableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector
public interface RecurringEventQueryInspector
extends OsidRuleQueryInspector, OsidContainableQueryInspector
This is the query inspector for examining recurring event queries.
-
Method Summary
Modifier and TypeMethodDescriptionGets the inclusive blackout terms.Gets the blackout terms.IdTerm[]Gets the calendarIdterms.Gets the calendar terms.IdTerm[]Gets the eventIdterms.Gets the event terms.getRecurringEventQueryInspectorRecord(Type recurringEventRecordType) Gets the recurring event query inspector record corresponding to the givenRecurringEventrecordType.IdTerm[]Gets the scheduleIdterms.Gets the schedule terms.Gets the date terms.IdTerm[]Gets the sponsorIdterms.Gets the sponsor terms.IdTerm[]Gets the superseding eventIdterms.Gets the superseding event terms.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface OsidContainableQueryInspector
getSequesteredTermsModifier and TypeMethodDescriptionGets the sequestered query terms.Methods inherited from interface OsidExtensibleQueryInspector
getRecordTypeTermsMethods inherited from interface OsidIdentifiableQueryInspector
getIdTermsMethods inherited from interface OsidObjectQueryInspector
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTermsModifier and TypeMethodDescriptionIdTerm[]Gets the commentIdquery terms.Gets the comment query terms.IdTerm[]Gets the creditIdquery terms.Gets the credit query terms.Gets the description query terms.Gets the display name query terms.TypeTerm[]Gets the genus type query terms.IdTerm[]Gets the journal entryIdquery terms.Gets the journal entry query terms.TypeTerm[]Gets the parent genus type query terms.IdTerm[]Gets the relationshipIdquery terms.IdTerm[]Gets the relationship peerIdquery terms.Gets the relationship query terms.IdTerm[]Gets the stateIdquery terms.Gets the state query terms.Gets the statistic query terms.IdTerm[]Gets the subjectIdquery terms.Gets the subject relevancy query terms.Gets the subject query terms.Methods inherited from interface OsidOperableQueryInspector
getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTermsModifier and TypeMethodDescriptionGets the active query terms.Gets the administratively disabled query terms.Gets the administratively enabled query terms.Gets the operational query terms.Methods inherited from interface OsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.Methods inherited from interface OsidRuleQueryInspector
getConditionRecordTypeTerms, getRuleIdTerms, getRuleTerms
-
Method Details
-
getScheduleIdTerms
IdTerm[] getScheduleIdTerms()Gets the scheduleIdterms.- Returns:
- the schedule
Idterms - Compliance:
mandatory- This method must be implemented.
-
getScheduleTerms
ScheduleQueryInspector[] getScheduleTerms()Gets the schedule terms.- Returns:
- the schedule terms
- Compliance:
mandatory- This method must be implemented.
-
getSupersedingEventIdTerms
IdTerm[] getSupersedingEventIdTerms()Gets the superseding eventIdterms.- Returns:
- the superseding event
Idterms - Compliance:
mandatory- This method must be implemented.
-
getSupersedingEventTerms
SupersedingEventQueryInspector[] getSupersedingEventTerms()Gets the superseding event terms.- Returns:
- the superseding event terms
- Compliance:
mandatory- This method must be implemented.
-
getEventIdTerms
IdTerm[] getEventIdTerms()Gets the eventIdterms.- Returns:
- the event
Idterms - Compliance:
mandatory- This method must be implemented.
-
getEventTerms
EventQueryInspector[] getEventTerms()Gets the event terms.- Returns:
- the event terms
- Compliance:
mandatory- This method must be implemented.
-
getBlackoutTerms
DateTimeTerm[] getBlackoutTerms()Gets the blackout terms.- Returns:
- the time terms
- Compliance:
mandatory- This method must be implemented.
-
getBlackoutInclusiveTerms
DateTimeRangeTerm[] getBlackoutInclusiveTerms()Gets the inclusive blackout terms.- Returns:
- the time range terms
- Compliance:
mandatory- This method must be implemented.
-
getSponsorIdTerms
IdTerm[] getSponsorIdTerms()Gets the sponsorIdterms.- Returns:
- the sponsor
Idterms - Compliance:
mandatory- This method must be implemented.
-
getSponsorTerms
ResourceQueryInspector[] getSponsorTerms()Gets the sponsor terms.- Returns:
- the sponsor terms
- Compliance:
mandatory- This method must be implemented.
-
getSpecificMeetingTimeTerms
DateTimeTerm[] getSpecificMeetingTimeTerms()Gets the date terms.- Returns:
- the time terms
- Compliance:
mandatory- This method must be implemented.
-
getCalendarIdTerms
IdTerm[] getCalendarIdTerms()Gets the calendarIdterms.- Returns:
- the calendar
Idterms - Compliance:
mandatory- This method must be implemented.
-
getCalendarTerms
CalendarQueryInspector[] getCalendarTerms()Gets the calendar terms.- Returns:
- the calendar terms
- Compliance:
mandatory- This method must be implemented.
-
getRecurringEventQueryInspectorRecord
RecurringEventQueryInspectorRecord getRecurringEventQueryInspectorRecord(Type recurringEventRecordType) throws OperationFailedException Gets the recurring event query inspector record corresponding to the givenRecurringEventrecordType.- Parameters:
recurringEventRecordType- a recurring event query record type- Returns:
- the recurring event query inspector record
- Throws:
NullArgumentException-recurringEventRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(recurringEventRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-