Interface RegistrationTargetSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RegistrationTargetSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
RegistrationTargetQueryInspector	getRegistrationTargetQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
RegistrationTargetList	getRegistrationTargets()	Gets the registration target list resulting from a search.
RegistrationTargetSearchResultsRecord	getRegistrationTargetSearchResultsRecord(Type registrationTargetSearchRecordType)	Gets the registration target search results record corresponding to the given registration target 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

getRegistrationTargets

RegistrationTargetList getRegistrationTargets()

Gets the registration target list resulting from a search.

Returns:

the registration target list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getRegistrationTargetQueryInspector

RegistrationTargetQueryInspector getRegistrationTargetQueryInspector()

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

Returns:

the registration target query inspector

Compliance:

mandatory - This method must be implemented.

getRegistrationTargetSearchResultsRecord

RegistrationTargetSearchResultsRecord getRegistrationTargetSearchResultsRecord(Type registrationTargetSearchRecordType)
                                                                        throws OperationFailedException

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

Parameters:

registrationTargetSearchRecordType - a registration target search record type

Returns:

the registration target search results record

Throws:

NullArgumentException - registrationTargetSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationTargetSearchRecordTypee) is false

Compliance:

mandatory - This method must be implemented.