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