Interface | osid.contact.AddressBookSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getAddressBooks | ||
Description |
Gets the address book list resulting from a search. | ||
Return | osid.contact.AddressBookList | the address book list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBookQueryInspector | ||
Description |
Gets the inspector for the query to examine the terns used in the search. | ||
Return | osid.contact.AddressBookQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBookSearchResultsRecord | ||
Description |
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 | osid.type.Type | addressBookSearchRecordType | an address book search record type |
Return | osid.contact.records.AddressBookSearchResultsRecord | the address book search results record | |
Errors | NULL_ARGUMENT | addressBookSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(addressBookSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |