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 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. |
changeBranch, initialize, rollbackService
close
getContactEnablerRecordTypes, getContactEnablerSearchRecordTypes, supportsContactEnablerAddressBook, supportsContactEnablerAddressBookAssignment, supportsContactEnablerAdmin, supportsContactEnablerLookup, supportsContactEnablerNotification, supportsContactEnablerQuery, supportsContactEnablerRecordType, supportsContactEnablerRuleApplication, supportsContactEnablerRuleLookup, supportsContactEnablerSearch, supportsContactEnablerSearchRecordType, supportsContactEnablerSmartAddressBook, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
ContactEnablerLookupSession getContactEnablerLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the contact
enabler lookup service.proxy
- a proxy ContactEnablerLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactEnablerLookup()
is false
optional
- This method must be implemented if
supportsContactEnablerLookup()
is true.
ContactEnablerLookupSession getContactEnablerLookupSessionForAddressBook(Id addressBookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the contact
enabler lookup service for the given address book.addressBookId
- the Id
of the AddressBook
proxy
- a proxy ContactEnablerLookupSession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- addressBookId or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactEnablerLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsContactEnablerLookup()
and
supportsVisibleFederation()
are true.
ContactEnablerQuerySession getContactEnablerQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the contact
enabler query service.proxy
- a proxy ContactEnablerQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactEnablerQuery()
is false
optional
- This method must be implemented if
supportsContactEnablerQuery()
is true.
ContactEnablerQuerySession getContactEnablerQuerySessionForAddressBook(Id addressBookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the contact
enabler query service for the given address book.addressBookId
- the Id
of the AddressBook
proxy
- a proxy ContactEnablerQuerySession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- addressBookId or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactEnablerQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsContactEnablerQuery()
and
supportsVisibleFederation()
are true.
ContactEnablerSearchSession getContactEnablerSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the contact
enabler search service.proxy
- a proxy ContactEnablerSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactEnablerSearch()
is false
optional
- This method must be implemented if
supportsContactEnablerSearch()
is true.
ContactEnablerSearchSession getContactEnablerSearchSessionForAddressBook(Id addressBookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the contact
enablers earch service for the given address book.addressBookId
- the Id
of the AddressBook
proxy
- a proxy ContactEnablerSearchSession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- addressBookId or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactEnablerSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsContactEnablerSearch()
and
supportsVisibleFederation()
are true.
ContactEnablerAdminSession getContactEnablerAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the contact
enabler administration service.proxy
- a proxy ContactEnablerAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactEnablerAdmin()
is false
optional
- This method must be implemented if
supportsContactEnablerAdmin()
is true.
ContactEnablerAdminSession getContactEnablerAdminSessionForAddressBook(Id addressBookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the contact
enabler administration service for the given address book.addressBookId
- the Id
of the AddressBook
proxy
- a proxy ContactEnablerAdminSession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- addressBookId or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactEnablerAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsContactEnablerAdmin()
and
supportsVisibleFederation()
are true.
ContactEnablerNotificationSession getContactEnablerNotificationSession(ContactEnablerReceiver contactEnablerReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the contact
enabler notification service.contactEnablerReceiver
- the notification callbackproxy
- a proxy ContactEnablerNotificationSession
NullArgumentException
- contactEnablerReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactEnablerNotification()
is false
optional
- This method must be implemented if
supportsContactEnablerNotification()
is
true.
ContactEnablerNotificationSession getContactEnablerNotificationSessionForAddressBook(ContactEnablerReceiver contactEnablerReceiver, Id addressBookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the contact
enabler notification service for the given address book.contactEnablerReceiver
- the notification callbackaddressBookId
- the Id
of the AddressBook
proxy
- a proxy ContactEnablerNotificationSession
NotFoundException
- no address book found by the given
Id
NullArgumentException
- contactEnablerReceiver,
addressBookId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactEnablerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsContactEnablerNotification()
and
supportsVisibleFederation()
are true.
ContactEnablerAddressBookSession getContactEnablerAddressBookSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup contact enabler/address
book mappings for contact enablers.proxy
- a proxy ContactEnablerAddressBookSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactEnablerAddressBook()
is false
optional
- This method must be implemented if
supportsContactEnablerAddressBook()
is
true.
ContactEnablerAddressBookAssignmentSession getContactEnablerAddressBookAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning contact
enablers to address books for contact.proxy
- a proxy ContactEnablerAddressBookAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactEnablerAddressBookAssignment()
is
false
optional
- This method must be implemented if
supportsContactEnablerAddressBookAssignment()
is
true.
ContactEnablerSmartAddressBookSession getContactEnablerSmartAddressBookSession(Id addressBookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage contact enabler smart
address books.addressBookId
- the Id
of the AddressBook
proxy
- a proxy ContactEnablerSmartAddressBookSession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- addressBookId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactEnablerSmartAddressBook()
is
false
optional
- This method must be implemented if
supportsContactEnablerSmartAddressBook()
is
true.
ContactEnablerRuleLookupSession getContactEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the contact
enabler mapping lookup service for looking up the rules applied to the
address book.proxy
- a proxy ContactEnablerRuleLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactEnablerRuleLookup()
is false
optional
- This method must be implemented if
supportsContactEnablerRuleLookup()
is true.
ContactEnablerRuleLookupSession getContactEnablerRuleLookupSessionForAddressBook(Id addressBookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the contact
enabler mapping lookup service for the given address book for looking
up rules applied to an address book.addressBookId
- the Id
of the AddressBook
proxy
- a proxy ContactEnablerRuleLookupSession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- addressBookId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactEnablerRuleLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsContactEnablerRuleLookup()
and
supportsVisibleFederation()
are true
ContactEnablerRuleApplicationSession getContactEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the contact
enabler assignment service to apply enablers.proxy
- a proxy ContactEnablerRuleApplicationSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactEnablerRuleApplication()
is
false
optional
- This method must be implemented if
supportsContactEnablerRuleApplication()
is
true.
ContactEnablerRuleApplicationSession getContactEnablerRuleApplicationSessionForAddressBook(Id addressBookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the contact
enabler assignment service for the given address book.addressBookId
- the Id
of the AddressBook
proxy
- a proxy ContactEnablerRuleApplicationSession
NotFoundException
- no AddressBook
found
by the given Id
NullArgumentException
- addressBookId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsContactEnablerRuleApplication()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsContactEnablerRuleApplication()
and
supportsVisibleFederation()
are true.