Interface ContactEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, ContactEnablerQuerySession, OsidSession, OsidSession

public interface ContactEnablerSearchSession
extends ContactEnablerQuerySession

This session provides methods for searching among ContactEnabler objects. The search query is constructed using the ContactEnableryQuery .

getContactEnablersByQuery() is the basic search method and returns a list of ContactEnablers . A more advanced search may be performed with getContactEnablersBySearch() . It accepts a ContactEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getContactEnablersBySearch() returns a ContactEnablerSearchResults that can be used to access the resulting ContactEnablerList or be used to perform a search within the result set through ContactEnablerSearch .

This session defines views that offer differing behaviors for searching.

• federated address book view: searches include contact enablers in address books of which this address book is an ancestor in the address book hierarchy
• isolated address book view: searches are restricted to contact enablers in this address book

ContactEnablers may have a query record indicated by their respective record types. The query record is accessed via the ContactEnablerQuery .

Method Summary

Modifier and Type	Method	Description
ContactEnablerQuery	getContactEnablerQueryFromInspector(ContactEnablerQueryInspector contactEnablerQueryInspector)	Gets a contact enabler query from an inspector.
ContactEnablerSearchResults	getContactEnablersBySearch(ContactEnablerQuery contactEnablerQuery, ContactEnablerSearch contactEnablerSearch)	Gets the search results matching the given search query using the given search.
ContactEnablerSearch	getContactEnablerSearch()	Gets a contact enabler search.
ContactEnablerSearchOrder	getContactEnablerSearchOrder()	Gets a contact enabler search order.

Methods inherited from interface Closeable

close

Methods inherited from interface ContactEnablerQuerySession

canSearchContactEnablers, getAddressBook, getAddressBookId, getContactEnablerQuery, getContactEnablersByQuery, useFederatedAddressBookView, useIsolatedAddressBookView

Modifier and Type	Method	Description
boolean	canSearchContactEnablers()	Tests if this user can perform ContactEnabler lookups.
AddressBook	getAddressBook()	Gets the AddressBook associated with this session.
Id	getAddressBookId()	Gets the AddressBook Id associated with this session.
ContactEnablerQuery	getContactEnablerQuery()	Gets a contact enabler query.
ContactEnablerList	getContactEnablersByQuery(ContactEnablerQuery contactEnablerQuery)	Gets a list of ContactEnablers matching the given contact enabler 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

getContactEnablerSearch

ContactEnablerSearch getContactEnablerSearch()

Gets a contact enabler search.

Returns:

the contact enabler search

Compliance:

mandatory - This method must be implemented.

getContactEnablerSearchOrder

ContactEnablerSearchOrder getContactEnablerSearchOrder()

Gets a contact enabler search order. The ContactEnablerSearchOrder is supplied to a ContactEnablerSearch to specify the ordering of results.

Returns:

the contact enabler search order

Compliance:

mandatory - This method must be implemented.

getContactEnablersBySearch

ContactEnablerSearchResults getContactEnablersBySearch(ContactEnablerQuery contactEnablerQuery,
 ContactEnablerSearch contactEnablerSearch)
                                                throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

contactEnablerQuery - the contact enabler query

contactEnablerSearch - the contact enabler search

Returns:

the returned search results

Throws:

NullArgumentException - contactEnablerQuery or contactEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - contactEnablerQuery or contactEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getContactEnablerQueryFromInspector

ContactEnablerQuery getContactEnablerQueryFromInspector(ContactEnablerQueryInspector contactEnablerQueryInspector)

Gets a contact enabler query from an inspector. The inspector is available from a ContactEnablerSearchResults .

Parameters:

contactEnablerQueryInspector - a contact enabler query inspector

Returns:

the contact enabler query

Throws:

NullArgumentException - contactEnablerQueryInspector is null

UnsupportedException - contactEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.