org.osid.contact.rules

Interface ContactRulesManager

All Superinterfaces:

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

public interface ContactRulesManager
extends OsidManager, ContactRulesProfile

The contact rules manager provides access to address book rules sessions and provides interoperability tests for various aspects of this service. 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() Gets the OsidSession associated with assigning contact enablers to address books for contact.
ContactEnablerAddressBookSession	getContactEnablerAddressBookSession() Gets the OsidSession to lookup contact enabler/address book mappings for contact enablers.
ContactEnablerAdminSession	getContactEnablerAdminSession() Gets the OsidSession associated with the contact enabler administration service.
ContactEnablerAdminSession	getContactEnablerAdminSessionForAddressBook(Id addressBookId) Gets the OsidSession associated with the contact enabler administration service for the given address book.
ContactEnablerLookupSession	getContactEnablerLookupSession() Gets the OsidSession associated with the contact enabler lookup service.
ContactEnablerLookupSession	getContactEnablerLookupSessionForAddressBook(Id addressBookId) Gets the OsidSession associated with the contact enabler lookup service for the given address book.
ContactEnablerNotificationSession	getContactEnablerNotificationSession(ContactEnablerReceiver contactEnablerReceiver) Gets the OsidSession associated with the contact enabler notification service.
ContactEnablerNotificationSession	getContactEnablerNotificationSessionForAddressBook(ContactEnablerReceiver contactEnablerReceiver, Id addressBookId) Gets the OsidSession associated with the contact enabler notification service for the given address book.
ContactEnablerQuerySession	getContactEnablerQuerySession() Gets the OsidSession associated with the contact enabler query service.
ContactEnablerQuerySession	getContactEnablerQuerySessionForAddressBook(Id addressBookId) Gets the OsidSession associated with the contact enabler query service for the given address book.
ContactEnablerRuleApplicationSession	getContactEnablerRuleApplicationSession() Gets the OsidSession associated with the contact enabler assignment service to apply enablers.
ContactEnablerRuleApplicationSession	getContactEnablerRuleApplicationSessionForAddressBook(Id addressBookId) Gets the OsidSession associated with the contact enabler assignment service for the given address book to apply enablers.
ContactEnablerRuleLookupSession	getContactEnablerRuleLookupSession() Gets the OsidSession associated with the contact enabler mapping lookup service.
ContactEnablerRuleLookupSession	getContactEnablerRuleLookupSessionForAddressBook(Id addressBookId) Gets the OsidSession associated with the contact enabler mapping lookup service for the given address book.
ContactEnablerSearchSession	getContactEnablerSearchSession() Gets the OsidSession associated with the contact enabler search service.
ContactEnablerSearchSession	getContactEnablerSearchSessionForAddressBook(Id addressBookId) Gets the OsidSession associated with the contact enablers earch service for the given address book.
ContactEnablerSmartAddressBookSession	getContactEnablerSmartAddressBookSession(Id addressBookId) Gets the OsidSession to manage contact enabler smart address books.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                                                           throws OperationFailedException

Gets the OsidSession associated with the contact enabler lookup service.

Returns:

a ContactEnablerLookupSession

Throws:

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)
                                                                         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

Returns:

a ContactEnablerLookupSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId 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()
                                                         throws OperationFailedException

Gets the OsidSession associated with the contact enabler query service.

Returns:

a ContactEnablerQuerySession

Throws:

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)
                                                                       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

Returns:

a ContactEnablerQuerySession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId 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()
                                                           throws OperationFailedException

Gets the OsidSession associated with the contact enabler search service.

Returns:

a ContactEnablerSearchSession

Throws:

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)
                                                                         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

Returns:

a ContactEnablerSearchSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId 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()
                                                         throws OperationFailedException

Gets the OsidSession associated with the contact enabler administration service.

Returns:

a ContactEnablerAdminSession

Throws:

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)
                                                                       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

Returns:

a ContactEnablerAdminSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId 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)
                                                                       throws OperationFailedException

Gets the OsidSession associated with the contact enabler notification service.

Parameters:

contactEnablerReceiver - the notification callback

Returns:

a ContactEnablerNotificationSession

Throws:

NullArgumentException - contactEnablerReceiver 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)
                                                                                     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

Returns:

a ContactEnablerNotificationSession

Throws:

NotFoundException - no address book found by the given Id

NullArgumentException - contactEnablerReceiver or addressBookId 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()
                                                                     throws OperationFailedException

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

Returns:

a ContactEnablerAddressBookSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsContactEnablerAddressBook() is false

Compliance:

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

getContactEnablerAddressBookAssignmentSession

ContactEnablerAddressBookAssignmentSession getContactEnablerAddressBookAssignmentSession()
                                                                                         throws OperationFailedException

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

Returns:

a ContactEnablerAddressBookAssignmentSession

Throws:

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)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

Gets the OsidSession to manage contact enabler smart address books.

Parameters:

addressBookId - the Id of the AddressBook

Returns:

a ContactEnablerSmartAddressBookSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId 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()
                                                                   throws OperationFailedException

Gets the OsidSession associated with the contact enabler mapping lookup service.

Returns:

a ContactEnablertRuleLookupSession

Throws:

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)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

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

Parameters:

addressBookId - the Id of the AddressBook

Returns:

a ContactEnablerRuleLookupSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId 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()
                                                                             throws OperationFailedException

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

Returns:

a ContactEnablerRuleApplicationSession

Throws:

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)
                                                                                           throws NotFoundException,
                                                                                                  OperationFailedException

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

Parameters:

addressBookId - the Id of the AddressBook

Returns:

a ContactEnablerRuleApplicationSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId 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.