Interface ProfileEntryEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProfileEntryEnablerSearch
extends OsidSearch

The search interface for governing profile entry enabler searches.

Method Summary

Modifier and Type	Method	Description
ProfileEntryEnablerSearchRecord	getProfileEntryEnablerSearchRecord(Type profileEntryEnablerSearchRecordType)	Gets the profile entry enabler search record corresponding to the given profile entry enabler search record Type.
void	orderProfileEntryEnablerResults(ProfileEntryEnablerSearchOrder profileEntryEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongProfileEntryEnablers(IdList profileEntryEnablerIds)	Execute this search among the given list of profile entry enablers.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongProfileEntryEnablers

void searchAmongProfileEntryEnablers(IdList profileEntryEnablerIds)

Execute this search among the given list of profile entry enablers.

Parameters:

profileEntryEnablerIds - list of profile entry enablers

Throws:

NullArgumentException - profileEntryEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderProfileEntryEnablerResults

void orderProfileEntryEnablerResults(ProfileEntryEnablerSearchOrder profileEntryEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

profileEntryEnablerSearchOrder - profile entry enabler search order

Throws:

NullArgumentException - profileEntryEnablerSearchOrder is null

UnsupportedException - profileEntryEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProfileEntryEnablerSearchRecord

ProfileEntryEnablerSearchRecord getProfileEntryEnablerSearchRecord(Type profileEntryEnablerSearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

profileEntryEnablerSearchRecordType - a profile entry enabler search record type

Returns:

the profile entry enabler search record

Throws:

NullArgumentException - profileEntryEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileEntryEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.