Interface SubjectSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface SubjectSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
SubjectQueryInspector	getSubjectQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
SubjectList	getSubjects()	Gets the subject list resulting from the search.
SubjectSearchResultsRecord	getSubjectSearchResultsRecord(Type subjectSearchRecordType)	Gets the subject search results record corresponding to the given subject 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

getSubjects

SubjectList getSubjects()

Gets the subject list resulting from the search.

Returns:

the subject list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getSubjectQueryInspector

SubjectQueryInspector getSubjectQueryInspector()

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

Returns:

the subject query inspector

Compliance:

mandatory - This method must be implemented.

getSubjectSearchResultsRecord

SubjectSearchResultsRecord getSubjectSearchResultsRecord(Type subjectSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

subjectSearchRecordType - a subject search record type

Returns:

the subject search results record

Throws:

NullArgumentException - subjectSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(subjectSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.