public interface ContactQuerySession extends OsidSession
This session provides methods for searching Contact
objects. The search query is constructed using the ContactQuery.
The address record Type
also specifies the record
for the address query.
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.
Modifier and Type | Method and 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.
|
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 canSearchContacts()
PERMISSION_DENIED.
This is intended as a hint to an
application that may not wish to offer search 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. ContactQuery getContactQuery()
mandatory
- This method must be implemented. ContactList getContactsByQuery(ContactQuery contactQuery) throws OperationFailedException, PermissionDeniedException
contactQuery
- the contact query ContactList
NullArgumentException
- contactQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- contactQuery
is
not of this servicemandatory
- This method must be implemented.