Interface AddressBookSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AddressBookSearch
extends OsidSearch

The search interface for governing address book searches.

Method Summary

Modifier and Type	Method	Description
AddressBookSearchRecord	getAddressBookSearchRecord(Type addressBookSearchRecordType)	Gets the address book search record corresponding to the given address book search record Type .This method is used to retrieve an object implementing the requested record interface.
void	orderAddressBookResults(AddressBookSearchOrder addressBooksearchOrder)	Specify an ordering to the search results.
void	searchAmongAddressBooks(IdList addressBookIds)	Execute this search among the given list of address books.

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

searchAmongAddressBooks

void searchAmongAddressBooks(IdList addressBookIds)

Execute this search among the given list of address books.

Parameters:

addressBookIds - list of address books

Throws:

NullArgumentException - addressBookIds is null

Compliance:

mandatory - This method must be implemented.

orderAddressBookResults

void orderAddressBookResults(AddressBookSearchOrder addressBooksearchOrder)

Specify an ordering to the search results.

Parameters:

addressBooksearchOrder - address book search order

Throws:

NullArgumentException - addressBooksearchOrder is null

UnsupportedException - addressBooksearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAddressBookSearchRecord

AddressBookSearchRecord getAddressBookSearchRecord(Type addressBookSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

addressBookSearchRecordType - an address book search record type

Returns:

the address book search record

Throws:

NullArgumentException - addressBooksearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(addressBooksearchRecordType) is false

Compliance:

mandatory - This method must be implemented.