Interface AuthorizationSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AuthorizationSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AuthorizationQueryInspector	getAuthorizationQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
AuthorizationList	getAuthorizations()	Gets the authorization list resulting from the search.
AuthorizationSearchResultsRecord	getAuthorizationSearchResultsRecord(Type authorizationSearchRecordType)	Gets the authorization search results record corresponding to the given authorization search record Type .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getAuthorizations

AuthorizationList getAuthorizations()

Gets the authorization list resulting from the search.

Returns:

the authorization list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAuthorizationQueryInspector

AuthorizationQueryInspector getAuthorizationQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getAuthorizationSearchResultsRecord

AuthorizationSearchResultsRecord getAuthorizationSearchResultsRecord(Type authorizationSearchRecordType)
                                                              throws OperationFailedException

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

Parameters:

authorizationSearchRecordType - an authorization search record type

Returns:

the authorization search results record

Throws:

NullArgumentException - authorizationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(authorizationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.