org.osid.profile.rules

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

Methods

Modifier and Type	Method and 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 org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

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.