org.osid.authorization.rules

Interface AuthorizationEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AuthorizationEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationEnablerQueryInspector	getAuthorizationEnablerQueryInspector() Gets the inspector for the query to examine the terms used in the search.
AuthorizationEnablerList	getAuthorizationEnablers() Gets the AuthorizationEnablerList resulting from a search.
AuthorizationEnablerSearchResultsRecord	getAuthorizationEnablerSearchResultsRecord(Type authorizationEnablerSearchRecordType) Gets the authorization enabler search results record corresponding to the given authorization enabler search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getAuthorizationEnablers

AuthorizationEnablerList getAuthorizationEnablers()

Gets the AuthorizationEnablerList resulting from a search.

Returns:

the authorization enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAuthorizationEnablerQueryInspector

AuthorizationEnablerQueryInspector getAuthorizationEnablerQueryInspector()

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

Returns:

the authorization enabler query inspector

Compliance:

mandatory - This method must be implemented.

getAuthorizationEnablerSearchResultsRecord

AuthorizationEnablerSearchResultsRecord getAuthorizationEnablerSearchResultsRecord(Type authorizationEnablerSearchRecordType)
                                                                                   throws OperationFailedException,
                                                                                          PermissionDeniedException

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.

Parameters:

authorizationEnablerSearchRecordType - an authorization enabler search record type

Returns:

the authorization enabler search results record

Throws:

NullArgumentException - authorizationEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(authorizationEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.