OSID Logo
OSID Specifications
authorization rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.rules.AuthorizationEnablerSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetAuthorizationEnablers
Description

Gets the AuthorizationEnablerList resulting from a search.

Returnosid.authorization.rules.AuthorizationEnablerListthe authorization enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationEnablerQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.authorization.rules.AuthorizationEnablerQueryInspectorthe authorization enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationEnablerSearchResultsRecord
Description

Gets the authorization enabler search results record corresponding to the given authorization enabler search record Type. This method must be used to retrieve an object implementing the requested record.

Parametersosid.type.TypeauthorizationEnablerSearchRecordTypean authorization enabler search record type
Returnosid.authorization.rules.records.AuthorizationEnablerSearchResultsRecordthe authorization enabler search results record
ErrorsNULL_ARGUMENT authorizationEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(authorizationEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.