public interface OfferingQueryInspector extends OsidRelationshipQueryInspector
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[] |
getCanonicalUnitIdTerms()
Gets the canonical unit
Id query terms. |
CanonicalUnitQueryInspector[] |
getCanonicalUnitTerms()
Gets the canonical unit query terms.
|
IdTerm[] |
getCatalogueIdTerms()
Gets the catalogue
Id query terms. |
CatalogueQueryInspector[] |
getCatalogueTerms()
Gets the catalogue query terms.
|
StringTerm[] |
getCodeTerms()
Gets the code query terms.
|
OfferingQueryInspectorRecord |
getOfferingQueryInspectorRecord(Type offeringRecordType)
Gets the offering query inspector record corresponding to the given
Offering record Type. |
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.
|
IdTerm[] |
getTimePeriodIdTerms()
Gets the time period
Id query terms. |
TimePeriodQueryInspector[] |
getTimePeriodTerms()
Gets the time period query terms.
|
StringTerm[] |
getTitleTerms()
Gets the title query terms.
|
getEndReasonIdTerms, getEndReasonTerms
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
getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms
IdTerm[] getCanonicalUnitIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. CanonicalUnitQueryInspector[] getCanonicalUnitTerms()
mandatory
- This method must be implemented. IdTerm[] getTimePeriodIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. TimePeriodQueryInspector[] getTimePeriodTerms()
mandatory
- This method must be implemented. StringTerm[] getTitleTerms()
mandatory
- This method must be implemented. StringTerm[] getCodeTerms()
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. OfferingQueryInspectorRecord getOfferingQueryInspectorRecord(Type offeringRecordType) throws OperationFailedException
Offering
record Type.
offeringRecordType
- an offering record typeNullArgumentException
- offeringRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(offeringRecordType)
is false
mandatory
- This method must be implemented.