OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
authorization package
Version 3.0.0
Release Candidate Preview
| Interface | osid.authorization.QualifierSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getQualifiers | ||
| Description |
Gets the qualifier list resulting from the search. | ||
| Return | osid.authorization.QualifierList | the qualifier list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getQualifierQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.authorization.QualifierQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getQualifierSearchResultsRecord | ||
| Description |
Gets the qualifier search results record corresponding
to the given qualifier search record | ||
| Parameters | osid.type.Type | qualifierSearchRecordType | a qualifier search record type |
| Return | osid.authorization.records.QualifierSearchResultsRecord | the qualifier search results record | |
| Errors | NULL_ARGUMENT | qualifierSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(qualifierSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |