Interface ProfileSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProfileSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ProfileQueryInspector	getProfileQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ProfileList	getProfiles()	Gets the profile list resulting from the search.
ProfileSearchResultsRecord	getProfileSearchResultsRecord(Type profileSearchRecordType)	Gets the profile search results record corresponding to the given profile 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

getProfiles

ProfileList getProfiles()

Gets the profile list resulting from the search.

Returns:

the profile list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getProfileQueryInspector

ProfileQueryInspector getProfileQueryInspector()

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.

getProfileSearchResultsRecord

ProfileSearchResultsRecord getProfileSearchResultsRecord(Type profileSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

profileSearchRecordType - a profile search record type

Returns:

the profile search results record

Throws:

NullArgumentException - profileSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.