Interface ContactEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ContactEnablerSearch
extends OsidSearch

The search interface for governing contact enabler searches.

Method Summary

Modifier and Type	Method	Description
ContactEnablerSearchRecord	getContactEnablerSearchRecord(Type contactEnablerSearchRecordType)	Gets the contact enabler search record corresponding to the given contact enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderContactEnablerResults(ContactEnablerSearchOrder contactEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongContactEnablers(IdList contactEnablerIds)	Execute this search among the given list of contact 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

searchAmongContactEnablers

void searchAmongContactEnablers(IdList contactEnablerIds)

Execute this search among the given list of contact enablers.

Parameters:

contactEnablerIds - list of contact enablers

Throws:

NullArgumentException - contactEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderContactEnablerResults

void orderContactEnablerResults(ContactEnablerSearchOrder contactEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

contactEnablerSearchOrder - contact enabler search order

Throws:

NullArgumentException - contactEnablerSearchOrder is null

UnsupportedException - contactEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getContactEnablerSearchRecord

ContactEnablerSearchRecord getContactEnablerSearchRecord(Type contactEnablerSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

contactEnablerSearchRecordType - a contact enabler search record type

Returns:

the contact enabler search record

Throws:

NullArgumentException - contactEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(contactEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.