Interface RegistrationRequestSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RegistrationRequestSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
RegistrationRequestQueryInspector	getRegistrationRequestQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
RegistrationRequestList	getRegistrationRequests()	Gets the registration request list resulting from a search.
RegistrationRequestSearchResultsRecord	getRegistrationRequestSearchResultsRecord(Type registrationRequestSearchRecordType)	Gets the registration request search results record corresponding to the given registration request search record Type.

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

getRegistrationRequests

RegistrationRequestList getRegistrationRequests()

Gets the registration request list resulting from a search.

Returns:

the registration request list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getRegistrationRequestQueryInspector

RegistrationRequestQueryInspector getRegistrationRequestQueryInspector()

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

Returns:

the registration request query inspector

Compliance:

mandatory - This method must be implemented.

getRegistrationRequestSearchResultsRecord

RegistrationRequestSearchResultsRecord getRegistrationRequestSearchResultsRecord(Type registrationRequestSearchRecordType)
                                                                          throws OperationFailedException

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

Parameters:

registrationRequestSearchRecordType - a registration request search record type

Returns:

the registration request search results record

Throws:

NullArgumentException - registrationRequestSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationRequestSearchRecordTypee) is false

Compliance:

mandatory - This method must be implemented.