public interface CanonicalUnitQueryInspector extends OsidObjectQueryInspector, OsidOperableQueryInspector
The query inspectors provide a means of accessing the match terms of a
query. These interfaces are used to examine the actual query terms used in
a search or that may be used to create a smart catalog. Query inspectors
may be converted to OsidQuery
interfaces for reuse or
modification in the search sessions.
Modifier and Type | Method and Description |
---|---|
CanonicalUnitQueryInspectorRecord |
getCanonicalUnitQueryInspectorRecord(Type canonicalUnitRecordType)
Gets the canonical unit query inspector record corresponding to the
given
CanonicalUnit record Type. |
IdTerm[] |
getCatalogueIdTerms()
Gets the catalogue
Id query terms. |
CatalogueQueryInspector[] |
getCatalogueTerms()
Gets the catalogue query terms.
|
StringTerm[] |
getCodeTerms()
Gets the code query terms.
|
IdTerm[] |
getOfferedCyclicTimePeriodIdTerms()
Gets the offered cyclic time period
Id query terms. |
CyclicTimePeriodQueryInspector[] |
getOfferedCyclicTimePeriodTerms()
Gets the offered cyclic time period query terms.
|
IdTerm[] |
getResultOptionIdTerms()
Gets the grade system
Id query terms. |
GradeSystemQueryInspector[] |
getResultOptionTerms()
Gets the grade system query terms.
|
IdTerm[] |
getSponsorIdTerms()
Gets the sponsor
Id query terms. |
ResourceQueryInspector[] |
getSponsorTerms()
Gets the sponsor query terms.
|
StringTerm[] |
getTitleTerms()
Gets the title query terms.
|
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms
getIdTerms
getRecordTypeTerms
getRecordTypes, hasRecordType
getAnyTerms, getKeywordTerms
getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms
StringTerm[] getTitleTerms()
mandatory
- This method must be implemented. StringTerm[] getCodeTerms()
mandatory
- This method must be implemented. IdTerm[] getOfferedCyclicTimePeriodIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. CyclicTimePeriodQueryInspector[] getOfferedCyclicTimePeriodTerms()
mandatory
- This method must be implemented. IdTerm[] getResultOptionIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. GradeSystemQueryInspector[] getResultOptionTerms()
mandatory
- This method must be implemented. IdTerm[] getSponsorIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. ResourceQueryInspector[] getSponsorTerms()
mandatory
- This method must be implemented. IdTerm[] getCatalogueIdTerms()
Id
query terms. Id
termsmandatory
- This method must be implemented. CatalogueQueryInspector[] getCatalogueTerms()
mandatory
- This method must be implemented. CanonicalUnitQueryInspectorRecord getCanonicalUnitQueryInspectorRecord(Type canonicalUnitRecordType) throws OperationFailedException
CanonicalUnit
record Type.
canonicalUnitRecordType
- a canonical unit record typeNullArgumentException
- canonicalUnitRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(canonicalUnitRecordType)
is false
mandatory
- This method must be implemented.