OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
osid package
Version 3.0.0
Release Candidate Preview
| Interface | osid.OsidObjectQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidIdentifiableQueryInspector | ||
osid.OsidExtensibleQueryInspector | |||
osid.OsidBrowsableQueryInspector | |||
| Description |
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
an | ||
| Method | getDisplayNameTerms | ||
| Description |
Gets the display name query terms. | ||
| Return | osid.search.terms.StringTerm[] | the display name terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescriptionTerms | ||
| Description |
Gets the description query terms. | ||
| Return | osid.search.terms.StringTerm[] | the description terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGenusTypeTerms | ||
| Description |
Gets the genus type query terms. | ||
| Return | osid.search.terms.TypeTerm[] | the genus type terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getParentGenusTypeTerms | ||
| Description |
Gets the parent genus type query terms. | ||
| Return | osid.search.terms.TypeTerm[] | the parent genus type terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubjectIdTerms | ||
| Description |
Gets the subject | ||
| Return | osid.search.terms.IdTerm[] | the subject Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubjectTerms | ||
| Description |
Gets the subject query terms. | ||
| Return | osid.ontology.SubjectQueryInspector[] | the subject query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubjectRelevancyTerms | ||
| Description |
Gets the subject relevancy query terms. | ||
| Return | osid.ontology.RelevancyQueryInspector[] | the subject relevancy query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStateIdTerms | ||
| Description |
Gets the state | ||
| Return | osid.search.terms.IdTerm[] | the state Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStateTerms | ||
| Description |
Gets the state query terms. | ||
| Return | osid.process.StateQueryInspector[] | the state query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommentIdTerms | ||
| Description |
Gets the comment | ||
| Return | osid.search.terms.IdTerm[] | the comment Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommentTerms | ||
| Description |
Gets the comment query terms. | ||
| Return | osid.commenting.CommentQueryInspector[] | the comment query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getJournalEntryIdTerms | ||
| Description |
Gets the journal entry | ||
| Return | osid.search.terms.IdTerm[] | the journal entry Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getJournalEntryTerms | ||
| Description |
Gets the journal entry query terms. | ||
| Return | osid.journaling.JournalEntryQueryInspector[] | the journal entry query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStatisticTerms | ||
| Description |
Gets the statistic query terms. | ||
| Return | osid.metering.StatisticQueryInspector[] | the statistic query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCreditIdTerms | ||
| Description |
Gets the credit | ||
| Return | osid.search.terms.IdTerm[] | the credit Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCreditTerms | ||
| Description |
Gets the credit query terms. | ||
| Return | osid.acknowledgement.CreditQueryInspector[] | the credit query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelationshipIdTerms | ||
| Description |
Gets the relationship | ||
| Return | osid.search.terms.IdTerm[] | the relationship Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelationshipTerms | ||
| Description |
Gets the relationship query terms. | ||
| Return | osid.relationship.RelationshipQueryInspector[] | the relationship query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelationshipPeerIdTerms | ||
| Description |
Gets the relationship peer | ||
| Return | osid.search.terms.IdTerm[] | the relationship peer Id terms | |
| Compliance | mandatory | This method must be implemented. | |