Interface ProfileEntryEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProfileEntryEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ProfileEntryEnablerQueryInspector	getProfileEntryEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ProfileEntryEnablerList	getProfileEntryEnablers()	Gets the ProfileEntryEnablerList resulting from a search.
ProfileEntryEnablerSearchResultsRecord	getProfileEntryEnablerSearchResultsRecord(Type profileEntryEnablerSearchRecordType)	Gets the profile entry enabler search results record corresponding to the given profile entry enabler 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

getProfileEntryEnablers

ProfileEntryEnablerList getProfileEntryEnablers()

Gets the ProfileEntryEnablerList resulting from a search.

Returns:

the profile entry enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getProfileEntryEnablerQueryInspector

ProfileEntryEnablerQueryInspector getProfileEntryEnablerQueryInspector()

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

Returns:

the profile entry enabler query inspector

Compliance:

mandatory - This method must be implemented.

getProfileEntryEnablerSearchResultsRecord

ProfileEntryEnablerSearchResultsRecord getProfileEntryEnablerSearchResultsRecord(Type profileEntryEnablerSearchRecordType)
                                                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

profileEntryEnablerSearchRecordType - a profile entry enabler search record type

Returns:

the profile entry enabler search results record

Throws:

NullArgumentException - profileEntryEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(profileEntryEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.