Interface ContactRulesProxyManager

All Superinterfaces:

AutoCloseable, Closeable, ContactRulesProfile, OsidProfile, OsidProxyManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface ContactRulesProfile

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

Modifier and Type	Method	Description
TypeList	getContactEnablerRecordTypes()	Gets the supported ContactEnabler record types.
TypeList	getContactEnablerSearchRecordTypes()	Gets the supported ContactEnabler search record types.
boolean	supportsContactEnablerAddressBook()	Tests if a contact enabler address book lookup service is supported.
boolean	supportsContactEnablerAddressBookAssignment()	Tests if a contact enabler address book service is supported.
boolean	supportsContactEnablerAdmin()	Tests if a contact enabler administrative service is supported.
boolean	supportsContactEnablerLookup()	Tests if looking up contact enablers is supported.
boolean	supportsContactEnablerNotification()	Tests if a contact enabler notification service is supported.
boolean	supportsContactEnablerQuery()	Tests if querying contact enablers is supported.
boolean	supportsContactEnablerRecordType(Type contactEnablerRecordType)	Tests if the given ContactEnabler record type is supported.
boolean	supportsContactEnablerRuleApplication()	Tests if a contact enabler rule application service is supported.
boolean	supportsContactEnablerRuleLookup()	Tests if a contact enabler rule lookup service is supported.
boolean	supportsContactEnablerSearch()	Tests if searching contact enablers is supported.
boolean	supportsContactEnablerSearchRecordType(Type contactEnablerSearchRecordType)	Tests if the given ContactEnabler search record type is supported.
boolean	supportsContactEnablerSmartAddressBook()	Tests if a contact enabler address book lookup service is supported.
boolean	supportsVisibleFederation()	Tests if any broker federation is exposed.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsContactEnablerLookup()} is {@code 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 {@code supportsContactEnablerLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsContactEnablerQuery()} is {@code 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 {@code supportsContactEnablerQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsContactEnablerSearch()} is {@code 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 {@code supportsContactEnablerSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsContactEnablerAdmin()} is {@code 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 {@code supportsContactEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsContactEnablerNotification()} is {@code 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 {@code supportsContactEnablerNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsContactEnablerAddressBook()} is {@code 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 {@code supportsContactEnablerAddressBookAssignment()} is {@code 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 {@code supportsContactEnablerSmartAddressBook()} is {@code 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 {@code supportsContactEnablerRuleLookup()} is {@code 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 {@code supportsContactEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsContactEnablerRuleApplication()} is {@code 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 {@code supportsContactEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .