OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
hold package
Version 3.0.0
Release Candidate Preview
| Interface | osid.hold.OublietteQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for examining oubliette queries. | ||
| Method | getBlockIdTerms | ||
| Description |
Gets the block | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBlockTerms | ||
| Description |
Gets the block query terms. | ||
| Return | osid.hold.BlockQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIssueIdTerms | ||
| Description |
Gets the issue | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIssueTerms | ||
| Description |
Gets the issue query terms. | ||
| Return | osid.hold.IssueQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getHoldIdTerms | ||
| Description |
Gets the hold | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getHoldTerms | ||
| Description |
Gets the hold query terms. | ||
| Return | osid.hold.HoldQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorOublietteIdTerms | ||
| Description |
Gets the ancestor oubliette | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorOublietteTerms | ||
| Description |
Gets the ancestor oubliette query terms. | ||
| Return | osid.hold.OublietteQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantOublietteIdTerms | ||
| Description |
Gets the descendant oubliette | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantOublietteTerms | ||
| Description |
Gets the descendant oubliette query terms. | ||
| Return | osid.hold.OublietteQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOublietteQueryInspectorRecord | ||
| Description |
Gets the oubliette query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | oublietteRecordType | an oubliette record type |
| Return | osid.hold.records.OublietteQueryInspectorRecord | the oubliette query inspector record | |
| Errors | NULL_ARGUMENT | oublietteRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(oublietteRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |