public interface CatalogueQueryInspector extends OsidCatalogQueryInspector
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 |
---|---|
IdTerm[] |
getAncestorCatalogueIdTerms()
Gets the ancestor catalogue
Id query terms. |
CatalogueQueryInspector[] |
getAncestorCatalogueTerms()
Gets the ancestor catalogue query terms.
|
IdTerm[] |
getCanonicalUnitIdTerms()
Gets the canonical unit
Id query terms. |
CanonicalUnitQueryInspector[] |
getCanonicalUnitTerms()
Gets the canonical unit query terms.
|
CatalogueQueryInspectorRecord |
getCatalogueQueryInspectorRecord(Type catalogueRecordType)
Gets the record query inspector record corresponding to the given
Catalogue record Type. |
IdTerm[] |
getDescendantCatalogueIdTerms()
Gets the descendant catalogue
Id query terms. |
CatalogueQueryInspector[] |
getDescendantCatalogueTerms()
Gets the descendant catalogue query terms.
|
IdTerm[] |
getOfferingIdTerms()
Gets the offering
Id query terms. |
OfferingQueryInspector[] |
getOfferingTerms()
Gets the offering query terms.
|
IdTerm[] |
getParticipantIdTerms()
Gets the participant
Id query terms. |
ParticipantQueryInspector[] |
getParticipantTerms()
Gets the participant query terms.
|
IdTerm[] |
getResultIdTerms()
Gets the result
Id query terms. |
ResultQueryInspector[] |
getResultTerms()
Gets the result 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
getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms
IdTerm[] getCanonicalUnitIdTerms()
Id
query terms. Id
termsmandatory
- This method must be implemented. CanonicalUnitQueryInspector[] getCanonicalUnitTerms()
mandatory
- This method must be implemented. IdTerm[] getOfferingIdTerms()
Id
query terms. Id
termsmandatory
- This method must be implemented. OfferingQueryInspector[] getOfferingTerms()
mandatory
- This method must be implemented. IdTerm[] getParticipantIdTerms()
Id
query terms. Id
termsmandatory
- This method must be implemented. ParticipantQueryInspector[] getParticipantTerms()
mandatory
- This method must be implemented. IdTerm[] getResultIdTerms()
Id
query terms. Id
termsmandatory
- This method must be implemented. ResultQueryInspector[] getResultTerms()
mandatory
- This method must be implemented. IdTerm[] getAncestorCatalogueIdTerms()
Id
query terms. Id
termsmandatory
- This method must be implemented. CatalogueQueryInspector[] getAncestorCatalogueTerms()
mandatory
- This method must be implemented. IdTerm[] getDescendantCatalogueIdTerms()
Id
query terms. Id
termsmandatory
- This method must be implemented. CatalogueQueryInspector[] getDescendantCatalogueTerms()
mandatory
- This method must be implemented. CatalogueQueryInspectorRecord getCatalogueQueryInspectorRecord(Type catalogueRecordType) throws OperationFailedException
Catalogue
record Type.
catalogueRecordType
- a catalogue record typeNullArgumentException
- catalogueRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(catalogueRecordType)
is false
mandatory
- This method must be implemented.