public interface AddressBookQuerySession extends OsidSession
This session provides methods for searching AddressBook
objects. The search query is constructed using the
AddressBookQuery.
The address book record Type
also
specifies the record for the address book query.
AddressBooks may have a query record indicated by their respective
record types. The query record is accessed via the
AddressBookQuery.
The returns in this session may not be cast
directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchAddressBooks()
Tests if this user can perform
AddressBook searches. |
AddressBookQuery |
getAddressBookQuery()
Gets an address book query.
|
AddressBookList |
getAddressBooksByQuery(AddressBookQuery addressBookQuery)
Gets a list of
AddressBooks matching the given search. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchAddressBooks()
AddressBook
searches. 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 opt not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. AddressBookQuery getAddressBookQuery()
mandatory
- This method must be implemented. AddressBookList getAddressBooksByQuery(AddressBookQuery addressBookQuery) throws OperationFailedException, PermissionDeniedException
AddressBooks
matching the given search.addressBookQuery
- the address book query AddressBookList
NullArgumentException
- addressBookQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- addressBookQuery
is not of this servicemandatory
- This method must be implemented.