public interface ContactEnablerQuerySession extends OsidSession
This session provides methods for searching among ContactEnabler
objects. The search query is constructed using the
ContactEnablerQuery.
This session defines views that offer differing behaviors for searching.
Contact enablers may have a query record indicated by their respective
record types. The query record is accessed via the
ContactEnablerQuery.
Modifier and Type | Method and 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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAddressBookId()
AddressBook
Id
associated with
this session. AddressBook Id
associated with this sessionmandatory
- This method must be implemented. AddressBook getAddressBook() throws OperationFailedException, PermissionDeniedException
AddressBook
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchContactEnablers()
ContactEnabler
lookups.
A return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may not offer lookup operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedAddressBookView()
mandatory
- This method is must be implemented. void useIsolatedAddressBookView()
mandatory
- This method is must be implemented. ContactEnablerQuery getContactEnablerQuery()
mandatory
- This method must be implemented. ContactEnablerList getContactEnablersByQuery(ContactEnablerQuery contactEnablerQuery) throws OperationFailedException, PermissionDeniedException
ContactEnablers
matching the given
contact enabler query.contactEnablerQuery
- the contact enabler query ContactEnablerList
NullArgumentException
- contactEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- contactEnablerQuery
is not of this servicemandatory
- This method must be implemented.