OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
hold package
Version 3.0.0
Release Candidate Preview
| Interface | osid.hold.HoldQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Description |
This is the query inspector for examining hold queries. | ||
| Method | getResourceIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceTerms | ||
| Description |
Gets the resource query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgentIdTerms | ||
| Description |
Gets the agent | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgentTerms | ||
| Description |
Gets the agent query terms. | ||
| Return | osid.authentication.AgentQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIssueIdTerms | ||
| Description |
Gets the issue query terms. | ||
| 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 | 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 | getHoldQueryInspectorRecord | ||
| Description |
Gets the hold query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | holdRecordType | a hold record type |
| Return | osid.hold.records.HoldQueryInspectorRecord | the hold query inspector record | |
| Errors | NULL_ARGUMENT | holdRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(holdRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |