public interface ContactSmartAddressBookSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A ContactQuery
can be retrieved from this session
and mapped to this AddressBook
to create a virtual
collection of Contacts.
The addresses may be sequenced
using the ContactSearchOrder
from this session.
This AddressBook
has a default query that matches any
contact and a default search order that specifies no sequencing. The
queries may be examined using a ContactQueryInspector.
The
query may be modified by converting the inspector back to a
ContactQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyContactQuery(ContactQuery contactQuery)
Applies a contact query to this address book.
|
void |
applyContactSequencing(ContactSearchOrder contactSearchOrder)
Applies a contact search order to this address book.
|
boolean |
canManageSmartAddressBooks()
Tests if this user can manage smart address books.
|
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.
|
ContactQuery |
getContactQueryFromInspector(ContactQueryInspector contactQueryInspector)
Gets a contact query from an inspector.
|
ContactSearchOrder |
getContactSearchOrder()
Gets a contact search order.
|
ContactQueryInspector |
inspectContactQuery()
Gets a contact query inspector for this address book.
|
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. AddressBook
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartAddressBooks()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart address book management is not
authorized, true
otherwisemandatory
- This method must be implemented. ContactQuery getContactQuery()
mandatory
- This method must be implemented. ContactSearchOrder getContactSearchOrder()
mandatory
- This method must be implemented. void applyContactQuery(ContactQuery contactQuery) throws OperationFailedException, PermissionDeniedException
contactQuery
- the contact queryNullArgumentException
- contactQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- contactQuery
not
of this servicemandatory
- This method must be implemented. ContactQueryInspector inspectContactQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyContactSequencing(ContactSearchOrder contactSearchOrder) throws OperationFailedException, PermissionDeniedException
contactSearchOrder
- the contact search orderNullArgumentException
- contactSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- contactSearchOrder
not of this servicemandatory
- This method must be implemented. ContactQuery getContactQueryFromInspector(ContactQueryInspector contactQueryInspector)
contactQueryInspector
- a query inspectorNullArgumentException
- contactQueryInspector
is null
UnsupportedException
- contactQueryInspector
is not of this servicemandatory
- This method must be implemented.