Interface RouteSegmentQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector
This is the query inspector for examining route segment queries.
-
Method Summary
Modifier and TypeMethodDescriptionGets the distance query terms.Gets the ending instruction query terms.Gets the ETA query terms.IdTerm[]Gets the pathIdquery terms.Gets the path query terms.IdTerm[]Gets the routeIdquery terms.getRouteSegmentQueryInspectorRecord(Type routeSegmentRecordType) Gets the route segment query inspector record corresponding to the givenRouteSegmentrecordType.Gets the route query terms.Gets the starting instruction query 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
-
getStartingInstructionsTerms
StringTerm[] getStartingInstructionsTerms()Gets the starting instruction query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getEndingInstructionsTerms
StringTerm[] getEndingInstructionsTerms()Gets the ending instruction query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getDistanceTerms
DistanceRangeTerm[] getDistanceTerms()Gets the distance query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getETATerms
DurationRangeTerm[] getETATerms()Gets the ETA query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getPathIdTerms
IdTerm[] getPathIdTerms()Gets the pathIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getPathTerms
PathQueryInspector[] getPathTerms()Gets the path query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getRouteIdTerms
IdTerm[] getRouteIdTerms()Gets the routeIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getRouteTerms
RouteQueryInspector[] getRouteTerms()Gets the route query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getRouteSegmentQueryInspectorRecord
RouteSegmentQueryInspectorRecord getRouteSegmentQueryInspectorRecord(Type routeSegmentRecordType) throws OperationFailedException Gets the route segment query inspector record corresponding to the givenRouteSegmentrecordType.- Parameters:
routeSegmentRecordType- a route segment record type- Returns:
- the route segment query inspector record
- Throws:
NullArgumentException-routeSegmentRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(routeSegmentRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-