Interface ContactSearchResults

All Superinterfaces:
Browsable, Extensible, OsidResult, OsidSearchResults
public interface ContactSearchResults extends OsidSearchResults

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

  • Method Details

    • getContacts

      ContactList getContacts()
      Gets the contact list resulting from a search.
      Returns:
      the contact list
      Throws:
      IllegalStateException - list has already been retrieved
      Compliance:
      mandatory - This method must be implemented.

    • getContactQueryInspector

      ContactQueryInspector getContactQueryInspector()
      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.

    • getContactSearchResultsRecord

      ContactSearchResultsRecord getContactSearchResultsRecord(Type contactSearchRecordType) throws OperationFailedException
      Gets the contact search results record corresponding to the given contact search record Type.This method is used to retrieve an object implementing the requested record.
      Parameters:
      contactSearchRecordType - a contact search record type
      Returns:
      the contact search record
      Throws:
      NullArgumentException - contactSearchRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(contactSearchRecordType) is false
      Compliance:
      mandatory - This method must be implemented.