public interface AddressBookSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and 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.
|
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
AddressBookList getAddressBooks()
IllegalStateException
- list has already been retrievedmandatory
- This method must be implemented. AddressBookQueryInspector getAddressBookQueryInspector()
mandatory
- This method must be implemented. AddressBookSearchResultsRecord getAddressBookSearchResultsRecord(Type addressBookSearchRecordType) throws OperationFailedException
addressBookSearchRecordType
- an address book search record typeNullArgumentException
-
addressBookSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(addressBookSearchRecordType)
is
false
mandatory
- This method must be implemented.