Interface TimePeriodQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector
This is the query inspector for examining time period queries.
-
Method Summary
Modifier and TypeMethodDescriptionIdTerm[]Gets the calendarIdterms.Gets the calendar terms.Gets the duration terms.Gets the end terms.IdTerm[]Gets the eventIdterms.Gets the event terms.IdTerm[]Gets the exception eventIdterms.Gets the exception event terms.Gets the start terms.Gets the inclusive time terms.getTimePeriodQueryInspectorRecord(Type timePeriodRecordType) Gets the time period query record interface corresponding to the givenTimePeriodrecordType.Gets the time 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
-
getStartTerms
DateTimeTerm[] getStartTerms()Gets the start terms.- Returns:
- the start terms
- Compliance:
mandatory- This method must be implemented.
-
getEndTerms
DateTimeTerm[] getEndTerms()Gets the end terms.- Returns:
- the end terms
- Compliance:
mandatory- This method must be implemented.
-
getTimeTerms
DateTimeTerm[] getTimeTerms()Gets the time terms.- Returns:
- the time terms
- Compliance:
mandatory- This method must be implemented.
-
getTimeInclusiveTerms
DateTimeRangeTerm[] getTimeInclusiveTerms()Gets the inclusive time terms.- Returns:
- the time range terms
- Compliance:
mandatory- This method must be implemented.
-
getDurationTerms
DurationTerm[] getDurationTerms()Gets the duration terms.- Returns:
- the duration terms
- Compliance:
mandatory- This method must be implemented.
-
getExceptionIdTerms
IdTerm[] getExceptionIdTerms()Gets the exception eventIdterms.- Returns:
- the exception event
Idterms - Compliance:
mandatory- This method must be implemented.
-
getExceptionTerms
EventQueryInspector[] getExceptionTerms()Gets the exception event terms.- Returns:
- the exception 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.
-
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.
-
getTimePeriodQueryInspectorRecord
TimePeriodQueryInspectorRecord getTimePeriodQueryInspectorRecord(Type timePeriodRecordType) throws OperationFailedException Gets the time period query record interface corresponding to the givenTimePeriodrecordType.- Parameters:
timePeriodRecordType- a time period query record type- Returns:
- the time period query inspector record
- Throws:
NullArgumentException-timePeriodRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(timePeriodRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-