OSID Specifications
hold rules package
Version 3.1.0
hold rules package
Version 3.1.0
| Interface | osid.hold.rules.HoldEnablerQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidEnablerQueryInspector | ||
| Used By | osid.hold.rules.HoldEnablerSearchResults | ||
osid.hold.rules.HoldEnablerSmartOublietteSession | |||
| Description |
This is the query inspector for examining hold enabler queries. | ||
| Method | getRuledHoldIdTerms | ||
| Description |
Gets the hold | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRuledHoldTerms | ||
| Description |
Gets the hold query terms. | ||
| Return | osid.hold.HoldQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOublietteIdTerms | ||
| Description |
Gets the oubliette | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOublietteTerms | ||
| Description |
Gets the oubliette query terms. | ||
| Return | osid.hold.OublietteQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getHoldEnablerQueryInspectorRecord | ||
| Description |
Gets the hold enabler query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | holdEnablerRecordType | a hold enabler record type |
| Return | osid.hold.rules.records.HoldEnablerQueryInspectorRecord | the hold enabler query inspector record | |
| Errors | NULL_ARGUMENT | holdEnablerRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(holdEnablerRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |