org.osid.contact.rules

Interface ContactEnablerSmartAddressBookSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface ContactEnablerSmartAddressBookSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic address books. A ContactEnablerQuery can be retrieved from this session and mapped to this AddressBook to create a virtual collection of contact enablers. The contact enablers may be sequenced using the ContactEnablerSearchOrder from this session.

This AddressBook has a default query that matches any contact enabler and a default search order that specifies no sequencing. The queries may be examined using a ContactEnablerQueryInspector. The query may be modified by converting the inspector back to a ContactEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyContactEnablerQuery(ContactEnablerQuery contactEnablerQuery) Applies a contact enabler query to this address book.
void	applyContactEnablerSequencing(ContactEnablerSearchOrder contactEnablerSearchOrder) Applies a contact enabler 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.
ContactEnablerQuery	getContactEnablerQuery() Gets a contact enabler query.
ContactEnablerQuery	getContactEnablerQueryFromInspector(ContactEnablerQueryInspector contactEnablerQueryInspector) Gets a contact enabler query from an inspector.
ContactEnablerSearchOrder	getContactEnablerSearchOrder() Gets a contact enabler search order.
ContactEnablerQueryInspector	inspectContactEnablerQuery() Gets a contact enabler query inspector for this address book.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getAddressBookId

Id getAddressBookId()

Gets the AddressBook Id associated with this session.

Returns:

the AddressBook Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAddressBook

AddressBook getAddressBook()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets the AddressBook associated with this session.

Returns:

the address book

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartAddressBooks

boolean canManageSmartAddressBooks()

Tests if this user can manage smart address books. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart address book management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getContactEnablerQuery

ContactEnablerQuery getContactEnablerQuery()

Gets a contact enabler query.

Returns:

the contact enabler query

Compliance:

mandatory - This method must be implemented.

getContactEnablerSearchOrder

ContactEnablerSearchOrder getContactEnablerSearchOrder()

Gets a contact enabler search order.

Returns:

the contact enabler search order

Compliance:

mandatory - This method must be implemented.

applyContactEnablerQuery

void applyContactEnablerQuery(ContactEnablerQuery contactEnablerQuery)
                              throws OperationFailedException,
                                     PermissionDeniedException

Applies a contact enabler query to this address book.

Parameters:

contactEnablerQuery - the contact enabler query

Throws:

NullArgumentException - contactEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - contactEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectContactEnablerQuery

ContactEnablerQueryInspector inspectContactEnablerQuery()
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Gets a contact enabler query inspector for this address book.

Returns:

the contact enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyContactEnablerSequencing

void applyContactEnablerSequencing(ContactEnablerSearchOrder contactEnablerSearchOrder)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Applies a contact enabler search order to this address book.

Parameters:

contactEnablerSearchOrder - the contact enabler search order

Throws:

NullArgumentException - contactEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - contactEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getContactEnablerQueryFromInspector

ContactEnablerQuery getContactEnablerQueryFromInspector(ContactEnablerQueryInspector contactEnablerQueryInspector)

Gets a contact enabler query from an inspector.

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.