Interface ScheduleQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector
This is the query inspector for examining schedule queries.
-
Method Summary
Modifier and TypeMethodDescriptionIdTerm[]Gets the calendarIdterms.Gets the calendar terms.Gets the limit terms.Gets the location description terms.IdTerm[]Gets the locationIdterms.Gets the location terms.Gets the schedule end terms.getScheduleQueryInspectorRecord(Type scheduleRecordType) Gets the schedule query inspector record corresponding to the givenSchedulerecordType.IdTerm[]Gets the schedule slotIdterms.Gets the schedule slot terms.Gets the schedule start terms.Gets the schedule inclusive time terms.Gets the schedule time terms.IdTerm[]Gets the time periodIdterms.Gets the time period terms.Gets the total duration 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 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 OsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.
-
Method Details
-
getScheduleSlotIdTerms
IdTerm[] getScheduleSlotIdTerms()Gets the schedule slotIdterms.- Returns:
- the schedule slot
Idterms - Compliance:
mandatory- This method must be implemented.
-
getScheduleSlotTerms
ScheduleSlotQueryInspector[] getScheduleSlotTerms()Gets the schedule slot terms.- Returns:
- the schedule slot terms
- Compliance:
mandatory- This method must be implemented.
-
getTimePeriodIdTerms
IdTerm[] getTimePeriodIdTerms()Gets the time periodIdterms.- Returns:
- the time period
Idterms - Compliance:
mandatory- This method must be implemented.
-
getTimePeriodTerms
TimePeriodQueryInspector[] getTimePeriodTerms()Gets the time period terms.- Returns:
- the time period terms
- Compliance:
mandatory- This method must be implemented.
-
getScheduleStartTerms
DateTimeRangeTerm[] getScheduleStartTerms()Gets the schedule start terms.- Returns:
- the schedule start terms
- Compliance:
mandatory- This method must be implemented.
-
getScheduleEndTerms
DateTimeRangeTerm[] getScheduleEndTerms()Gets the schedule end terms.- Returns:
- the schedule end terms
- Compliance:
mandatory- This method must be implemented.
-
getScheduleTimeTerms
DateTimeTerm[] getScheduleTimeTerms()Gets the schedule time terms.- Returns:
- the schedule time terms
- Compliance:
mandatory- This method must be implemented.
-
getScheduleTimeInclusiveTerms
DateTimeRangeTerm[] getScheduleTimeInclusiveTerms()Gets the schedule inclusive time terms.- Returns:
- the schedule time range terms
- Compliance:
mandatory- This method must be implemented.
-
getLimitTerms
CardinalTerm[] getLimitTerms()Gets the limit terms.- Returns:
- the limit terms
- Compliance:
mandatory- This method must be implemented.
-
getLocationDescriptionTerms
StringTerm[] getLocationDescriptionTerms()Gets the location description terms.- Returns:
- the location description terms
- Compliance:
mandatory- This method must be implemented.
-
getLocationIdTerms
IdTerm[] getLocationIdTerms()Gets the locationIdterms.- Returns:
- the location
Idterms - Compliance:
mandatory- This method must be implemented.
-
getLocationTerms
LocationQueryInspector[] getLocationTerms()Gets the location terms.- Returns:
- the location terms
- Compliance:
mandatory- This method must be implemented.
-
getTotalDurationTerms
DurationRangeTerm[] getTotalDurationTerms()Gets the total duration terms.- Returns:
- the duration 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.
-
getScheduleQueryInspectorRecord
ScheduleQueryInspectorRecord getScheduleQueryInspectorRecord(Type scheduleRecordType) throws OperationFailedException Gets the schedule query inspector record corresponding to the givenSchedulerecordType.- Parameters:
scheduleRecordType- a schedule query record type- Returns:
- the schedule query inspector record
- Throws:
NullArgumentException-scheduleRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(scheduleRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-