Interface ContactSearchSession

All Superinterfaces:

AutoCloseable, Closeable, ContactQuerySession, OsidSession, OsidSession

public interface ContactSearchSession
extends ContactQuerySession

This session provides methods for searching Contacts. The search query is constructed using the ContactQuery. The contact record Type also specifies the record for the contact query.

getContactsByQuery() is the basic search method and returns a list of AddressBook elements. A more advanced search may be performed with getContactsBySearch().It accepts a ContactSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getContactsBySearch() returns a ContactSearchResults that can be used to access the resulting ContactList or be used to perform a search within the result set through ContactSearch.

Contacts may have a query record indicated by their respective record types. The query record is accessed via the ContactQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Modifier and Type	Method	Description
ContactQuery	getContactQueryFromInspector(ContactQueryInspector contactQueryInspector)	Gets a contact query from an inspector.
ContactSearchResults	getContactsBySearch(ContactQuery contactQuery, ContactSearch contactSearch)	Gets the search results matching the given search.
ContactSearch	getContactSearch()	Gets a contact search.
ContactSearchOrder	getContactSearchOrder()	Gets a contact search order.

Methods inherited from interface Closeable

close

Methods inherited from interface ContactQuerySession

canSearchContacts, getAddressBook, getAddressBookId, getContactQuery, getContactsByQuery, useFederatedAddressBookView, useIsolatedAddressBookView

Modifier and Type	Method	Description
boolean	canSearchContacts()	Tests if this user can perform susbcription searches.
AddressBook	getAddressBook()	Gets the AddressBook associated with this session.
Id	getAddressBookId()	Gets the AddressBook Id associated with this session.
ContactQuery	getContactQuery()	Gets a contact query.
ContactList	getContactsByQuery(ContactQuery contactQuery)	Gets a list of contacts matching the given contact query.
void	useFederatedAddressBookView()	Federates the view for methods in this session.
void	useIsolatedAddressBookView()	Isolates the view for methods in this session.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getContactSearch

ContactSearch getContactSearch()

Gets a contact search.

Returns:

the contact search

Compliance:

mandatory - This method must be implemented.

getContactSearchOrder

ContactSearchOrder getContactSearchOrder()

Gets a contact search order. The ContactSearchOrder is supplied to a ContactSearch to specify the ordering of results.

Returns:

the contact search order interface

Compliance:

mandatory - This method must be implemented.

getContactsBySearch

ContactSearchResults getContactsBySearch(ContactQuery contactQuery,
 ContactSearch contactSearch)
                                  throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

contactQuery - the contact query

contactSearch - the contact search

Returns:

the contact search results

Throws:

NullArgumentException - contactQuery or contactSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - contactQuery or contactSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getContactQueryFromInspector

ContactQuery getContactQueryFromInspector(ContactQueryInspector contactQueryInspector)

Gets a contact query from an inspector. The inspector is available from a ContactSearchResults.

Parameters:

contactQueryInspector - a contact query inspector

Returns:

the contact query

Throws:

NullArgumentException - contactQueryInspector is null

UnsupportedException - contactQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.