public interface ContactSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
ContactQueryInspector |
getContactQueryInspector()
Gets the inspector for the query to examine the terns used in the
search.
|
ContactList |
getContacts()
Gets the contact list resulting from a search.
|
ContactSearchResultsRecord |
getContactSearchResultsRecord(Type contactSearchRecordType)
Gets the contact search results record corresponding to the given
contact search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
ContactList getContacts()
IllegalStateException
- list has already been retrievedmandatory
- This method must be implemented. ContactQueryInspector getContactQueryInspector()
mandatory
- This method must be implemented. ContactSearchResultsRecord getContactSearchResultsRecord(Type contactSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.contactSearchRecordType
- a contact search record typeNullArgumentException
- contactSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(contactSearchRecordType)
is false
mandatory
- This method must be implemented.