Interface AddressBookSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AddressBookSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
AddressBookQueryInspector	getAddressBookQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
AddressBookList	getAddressBooks()	Gets the address book list resulting from a search.
AddressBookSearchResultsRecord	getAddressBookSearchResultsRecord(Type addressBookSearchRecordType)	Gets the address book search rsults record corresponding to the given address book search record Type.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getAddressBooks

AddressBookList getAddressBooks()

Gets the address book list resulting from a search.

Returns:

the address book list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAddressBookQueryInspector

AddressBookQueryInspector getAddressBookQueryInspector()

Gets the inspector for the query to examine the terns used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getAddressBookSearchResultsRecord

AddressBookSearchResultsRecord getAddressBookSearchResultsRecord(Type addressBookSearchRecordType)
                                                          throws OperationFailedException

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

Parameters:

addressBookSearchRecordType - an address book search record type

Returns:

the address book search results record

Throws:

NullArgumentException - addressBookSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(addressBookSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.