Interface ContactSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ContactSearch
extends OsidSearch

The search interface for governing contact searches.

Method Summary

Modifier and Type	Method	Description
ContactSearchRecord	getContactSearchRecord(Type contactSearchRecordType)	Gets the contact search record corresponding to the given contact search record Type .
void	orderContactResults(ContactSearchOrder contactSearchOrder)	Specify an ordering to the search results.
void	searchAmongContacts(IdList contactIds)	Execute this search among the given list of contacts.

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

searchAmongContacts

void searchAmongContacts(IdList contactIds)

Execute this search among the given list of contacts.

Parameters:

contactIds - list of contacts

Throws:

NullArgumentException - contactIds is null

Compliance:

mandatory - This method must be implemented.

orderContactResults

void orderContactResults(ContactSearchOrder contactSearchOrder)

Specify an ordering to the search results.

Parameters:

contactSearchOrder - contact search order

Throws:

NullArgumentException - contactSearchOrder is null

UnsupportedException - contactSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getContactSearchRecord

ContactSearchRecord getContactSearchRecord(Type contactSearchRecordType)
                                    throws OperationFailedException

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

Parameters:

contactSearchRecordType - a contact search record type

Returns:

the contact search record

Throws:

NullArgumentException - contactSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(contactSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.