Interface ProfileEntrySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProfileEntrySearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ProfileEntryList	getProfileEntries()	Gets the profile entry list resulting from the search.
ProfileEntryQueryInspector	getProfileEntryQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ProfileEntrySearchResultsRecord	getProfileEntrySearchResultsRecord(Type profileEntrySearchRecordType)	Gets the profile entry search results record corresponding to the given profile entry 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

getProfileEntries

ProfileEntryList getProfileEntries()

Gets the profile entry list resulting from the search.

Returns:

the profile entry list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getProfileEntryQueryInspector

ProfileEntryQueryInspector getProfileEntryQueryInspector()

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

Returns:

the profile entry query inspector

Compliance:

mandatory - This method must be implemented.

getProfileEntrySearchResultsRecord

ProfileEntrySearchResultsRecord getProfileEntrySearchResultsRecord(Type profileEntrySearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

profileEntrySearchRecordType - a profile entry search record type

Returns:

the profile entry search results record

Throws:

NullArgumentException - profileEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.