org.osid.contact.rules

Interface ContactRulesProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ContactRulesProfile, OsidProfile, OsidProxyManager, Sourceable

public interface ContactRulesProxyManager
extends OsidProxyManager, ContactRulesProfile

The contact rules proxy manager provides access to contact rules sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. The sessions included in this manager are:

• ContactEnablerLookupSession: a session to retrieve contact enablers
• ContactEnablerQuerySession: a session to query for contact enablers
• ContactEnablerSearchSession: a session to search for contact enablers
• ContactEnablerAdminSession: a session to create and delete contact enablers
• ContactEnablerNotificationSession: a session to receive notifications pertaining to contact enabler changes
• ContactEnablerAddressBookSession: a session to look up contact enabler address book mappings
• ContactEnablerAddressBookAssignmentSession: a session to manage contact enabler to address book mappings
• ContactEnablerSmartAddressBookSession: a session to manage dynamic address books of contact enablers
• ContactEnablerRuleLookupSession: a session to look up contact enabler to contact mappings
• ContactEnablerRuleApplicationSession: a session to apply contact enablers to contacts

Method Summary

Methods

Modifier and Type	Method and Description
ContactEnablerAddressBookAssignmentSession	getContactEnablerAddressBookAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning contact enablers to address books for contact.
ContactEnablerAddressBookSession	getContactEnablerAddressBookSession(Proxy proxy) Gets the OsidSession to lookup contact enabler/address book mappings for contact enablers.
ContactEnablerAdminSession	getContactEnablerAdminSession(Proxy proxy) Gets the OsidSession associated with the contact enabler administration service.
ContactEnablerAdminSession	getContactEnablerAdminSessionForAddressBook(Id addressBookId, Proxy proxy) Gets the OsidSession associated with the contact enabler administration service for the given address book.
ContactEnablerLookupSession	getContactEnablerLookupSession(Proxy proxy) Gets the OsidSession associated with the contact enabler lookup service.
ContactEnablerLookupSession	getContactEnablerLookupSessionForAddressBook(Id addressBookId, Proxy proxy) Gets the OsidSession associated with the contact enabler lookup service for the given address book.
ContactEnablerNotificationSession	getContactEnablerNotificationSession(ContactEnablerReceiver contactEnablerReceiver, Proxy proxy) Gets the OsidSession associated with the contact enabler notification service.
ContactEnablerNotificationSession	getContactEnablerNotificationSessionForAddressBook(ContactEnablerReceiver contactEnablerReceiver, Id addressBookId, Proxy proxy) Gets the OsidSession associated with the contact enabler notification service for the given address book.
ContactEnablerQuerySession	getContactEnablerQuerySession(Proxy proxy) Gets the OsidSession associated with the contact enabler query service.
ContactEnablerQuerySession	getContactEnablerQuerySessionForAddressBook(Id addressBookId, Proxy proxy) Gets the OsidSession associated with the contact enabler query service for the given address book.
ContactEnablerRuleApplicationSession	getContactEnablerRuleApplicationSession(Proxy proxy) Gets the OsidSession associated with the contact enabler assignment service to apply enablers.
ContactEnablerRuleApplicationSession	getContactEnablerRuleApplicationSessionForAddressBook(Id addressBookId, Proxy proxy) Gets the OsidSession associated with the contact enabler assignment service for the given address book.
ContactEnablerRuleLookupSession	getContactEnablerRuleLookupSession(Proxy proxy) Gets the OsidSession associated with the contact enabler mapping lookup service for looking up the rules applied to the address book.
ContactEnablerRuleLookupSession	getContactEnablerRuleLookupSessionForAddressBook(Id addressBookId, Proxy proxy) Gets the OsidSession associated with the contact enabler mapping lookup service for the given address book for looking up rules applied to an address book.
ContactEnablerSearchSession	getContactEnablerSearchSession(Proxy proxy) Gets the OsidSession associated with the contact enabler search service.
ContactEnablerSearchSession	getContactEnablerSearchSessionForAddressBook(Id addressBookId, Proxy proxy) Gets the OsidSession associated with the contact enablers earch service for the given address book.
ContactEnablerSmartAddressBookSession	getContactEnablerSmartAddressBookSession(Id addressBookId, Proxy proxy) Gets the OsidSession to manage contact enabler smart address books.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.contact.rules.ContactRulesProfile

getContactEnablerRecordTypes, getContactEnablerSearchRecordTypes, supportsContactEnablerAddressBook, supportsContactEnablerAddressBookAssignment, supportsContactEnablerAdmin, supportsContactEnablerLookup, supportsContactEnablerNotification, supportsContactEnablerQuery, supportsContactEnablerRecordType, supportsContactEnablerRuleApplication, supportsContactEnablerRuleLookup, supportsContactEnablerSearch, supportsContactEnablerSearchRecordType, supportsContactEnablerSmartAddressBook, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getContactEnablerLookupSession

ContactEnablerLookupSession getContactEnablerLookupSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the contact enabler lookup service.

Parameters:

proxy - a proxy

Returns:

a ContactEnablerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerLookup() is false

Compliance:

optional - This method must be implemented if supportsContactEnablerLookup() is true.

getContactEnablerLookupSessionForAddressBook

ContactEnablerLookupSession getContactEnablerLookupSessionForAddressBook(Id addressBookId,
                                                                       Proxy proxy)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

Gets the OsidSession associated with the contact enabler lookup service for the given address book.

Parameters:

addressBookId - the Id of the AddressBook

proxy - a proxy

Returns:

a ContactEnablerLookupSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsContactEnablerLookup() and supportsVisibleFederation() are true.

getContactEnablerQuerySession

ContactEnablerQuerySession getContactEnablerQuerySession(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the contact enabler query service.

Parameters:

proxy - a proxy

Returns:

a ContactEnablerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerQuery() is false

Compliance:

optional - This method must be implemented if supportsContactEnablerQuery() is true.

getContactEnablerQuerySessionForAddressBook

ContactEnablerQuerySession getContactEnablerQuerySessionForAddressBook(Id addressBookId,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the OsidSession associated with the contact enabler query service for the given address book.

Parameters:

addressBookId - the Id of the AddressBook

proxy - a proxy

Returns:

a ContactEnablerQuerySession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsContactEnablerQuery() and supportsVisibleFederation() are true.

getContactEnablerSearchSession

ContactEnablerSearchSession getContactEnablerSearchSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the contact enabler search service.

Parameters:

proxy - a proxy

Returns:

a ContactEnablerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerSearch() is false

Compliance:

optional - This method must be implemented if supportsContactEnablerSearch() is true.

getContactEnablerSearchSessionForAddressBook

ContactEnablerSearchSession getContactEnablerSearchSessionForAddressBook(Id addressBookId,
                                                                       Proxy proxy)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

Gets the OsidSession associated with the contact enablers earch service for the given address book.

Parameters:

addressBookId - the Id of the AddressBook

proxy - a proxy

Returns:

a ContactEnablerSearchSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsContactEnablerSearch() and supportsVisibleFederation() are true.

getContactEnablerAdminSession

ContactEnablerAdminSession getContactEnablerAdminSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the contact enabler administration service.

Parameters:

proxy - a proxy

Returns:

a ContactEnablerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerAdmin() is false

Compliance:

optional - This method must be implemented if supportsContactEnablerAdmin() is true.

getContactEnablerAdminSessionForAddressBook

ContactEnablerAdminSession getContactEnablerAdminSessionForAddressBook(Id addressBookId,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the OsidSession associated with the contact enabler administration service for the given address book.

Parameters:

addressBookId - the Id of the AddressBook

proxy - a proxy

Returns:

a ContactEnablerAdminSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsContactEnablerAdmin() and supportsVisibleFederation() are true.

getContactEnablerNotificationSession

ContactEnablerNotificationSession getContactEnablerNotificationSession(ContactEnablerReceiver contactEnablerReceiver,
                                                                     Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with the contact enabler notification service.

Parameters:

contactEnablerReceiver - the notification callback

proxy - a proxy

Returns:

a ContactEnablerNotificationSession

Throws:

NullArgumentException - contactEnablerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerNotification() is false

Compliance:

optional - This method must be implemented if supportsContactEnablerNotification() is true.

getContactEnablerNotificationSessionForAddressBook

ContactEnablerNotificationSession getContactEnablerNotificationSessionForAddressBook(ContactEnablerReceiver contactEnablerReceiver,
                                                                                   Id addressBookId,
                                                                                   Proxy proxy)
                                                                                     throws NotFoundException,
                                                                                            OperationFailedException

Gets the OsidSession associated with the contact enabler notification service for the given address book.

Parameters:

contactEnablerReceiver - the notification callback

addressBookId - the Id of the AddressBook

proxy - a proxy

Returns:

a ContactEnablerNotificationSession

Throws:

NotFoundException - no address book found by the given Id

NullArgumentException - contactEnablerReceiver, addressBookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsContactEnablerNotification() and supportsVisibleFederation() are true.

getContactEnablerAddressBookSession

ContactEnablerAddressBookSession getContactEnablerAddressBookSession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession to lookup contact enabler/address book mappings for contact enablers.

Parameters:

proxy - a proxy

Returns:

a ContactEnablerAddressBookSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerAddressBook() is false

Compliance:

optional - This method must be implemented if supportsContactEnablerAddressBook() is true.

getContactEnablerAddressBookAssignmentSession

ContactEnablerAddressBookAssignmentSession getContactEnablerAddressBookAssignmentSession(Proxy proxy)
                                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning contact enablers to address books for contact.

Parameters:

proxy - a proxy

Returns:

a ContactEnablerAddressBookAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerAddressBookAssignment() is false

Compliance:

optional - This method must be implemented if supportsContactEnablerAddressBookAssignment() is true.

getContactEnablerSmartAddressBookSession

ContactEnablerSmartAddressBookSession getContactEnablerSmartAddressBookSession(Id addressBookId,
                                                                             Proxy proxy)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

Gets the OsidSession to manage contact enabler smart address books.

Parameters:

addressBookId - the Id of the AddressBook

proxy - a proxy

Returns:

a ContactEnablerSmartAddressBookSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerSmartAddressBook() is false

Compliance:

optional - This method must be implemented if supportsContactEnablerSmartAddressBook() is true.

getContactEnablerRuleLookupSession

ContactEnablerRuleLookupSession getContactEnablerRuleLookupSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the contact enabler mapping lookup service for looking up the rules applied to the address book.

Parameters:

proxy - a proxy

Returns:

a ContactEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if supportsContactEnablerRuleLookup() is true.

getContactEnablerRuleLookupSessionForAddressBook

ContactEnablerRuleLookupSession getContactEnablerRuleLookupSessionForAddressBook(Id addressBookId,
                                                                               Proxy proxy)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

Gets the OsidSession associated with the contact enabler mapping lookup service for the given address book for looking up rules applied to an address book.

Parameters:

addressBookId - the Id of the AddressBook

proxy - a proxy

Returns:

a ContactEnablerRuleLookupSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsContactEnablerRuleLookup() and supportsVisibleFederation() are true

getContactEnablerRuleApplicationSession

ContactEnablerRuleApplicationSession getContactEnablerRuleApplicationSession(Proxy proxy)
                                                                             throws OperationFailedException

Gets the OsidSession associated with the contact enabler assignment service to apply enablers.

Parameters:

proxy - a proxy

Returns:

a ContactEnablerRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if supportsContactEnablerRuleApplication() is true.

getContactEnablerRuleApplicationSessionForAddressBook

ContactEnablerRuleApplicationSession getContactEnablerRuleApplicationSessionForAddressBook(Id addressBookId,
                                                                                         Proxy proxy)
                                                                                           throws NotFoundException,
                                                                                                  OperationFailedException

Gets the OsidSession associated with the contact enabler assignment service for the given address book.

Parameters:

addressBookId - the Id of the AddressBook

proxy - a proxy

Returns:

a ContactEnablerRuleApplicationSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsContactEnablerRuleApplication() and supportsVisibleFederation() are true.