public interface ContactSearch extends OsidSearch
The search interface for governing contact searches.
Modifier and Type | Method and Description |
---|---|
ContactSearchRecord |
getContactSearchRecord(Type contactSearchRecordType)
Gets the contact search record corresponding to the given contact
search record
Type. |
void |
orderContactResults(ContactSearchOrder contactSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongContacts(IdList contactIds)
Execute this search among the given list of contacts.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongContacts(IdList contactIds)
contactIds
- list of contactsNullArgumentException
- contactIds
is
null
mandatory
- This method must be implemented. void orderContactResults(ContactSearchOrder contactSearchOrder)
contactSearchOrder
- contact search orderNullArgumentException
- contactSearchOrder
is null
UnsupportedException
- contactSearchOrder
is not of this servicemandatory
- This method must be implemented. ContactSearchRecord getContactSearchRecord(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.