OSID - osid.contact.rules.ContactRulesManager Service Interface Definition

Interface	osid.contact.rules.ContactRulesManager
Implements	`osid.OsidManager`
Implements	`osid.contact.rules.ContactRulesProfile`
Description	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	getContactEnablerLookupSession
Description	Gets the `OsidSession` associated with the contact enabler lookup service.
Return	`osid.contact.rules.ContactEnablerLookupSession`		a `ContactEnablerLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsContactEnablerLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactEnablerLookup()` is `true.`
Method	getContactEnablerLookupSessionForAddressBook
Description	Gets the `OsidSession` associated with the contact enabler lookup service for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Return	`osid.contact.rules.ContactEnablerLookupSession`		a `ContactEnablerLookupSession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsContactEnablerLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactEnablerLookup()` and `supportsVisibleFederation()` are `true.`
Method	getContactEnablerQuerySession
Description	Gets the `OsidSession` associated with the contact enabler query service.
Return	`osid.contact.rules.ContactEnablerQuerySession`		a `ContactEnablerQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsContactEnablerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactEnablerQuery()` is `true.`
Method	getContactEnablerQuerySessionForAddressBook
Description	Gets the `OsidSession` associated with the contact enabler query service for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Return	`osid.contact.rules.ContactEnablerQuerySession`		a `ContactEnablerQuerySession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsContactEnablerQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactEnablerQuery()` and `supportsVisibleFederation()` are `true.`
Method	getContactEnablerSearchSession
Description	Gets the `OsidSession` associated with the contact enabler search service.
Return	`osid.contact.rules.ContactEnablerSearchSession`		a `ContactEnablerSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsContactEnablerSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactEnablerSearch()` is `true.`
Method	getContactEnablerSearchSessionForAddressBook
Description	Gets the `OsidSession` associated with the contact enablers earch service for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Return	`osid.contact.rules.ContactEnablerSearchSession`		a `ContactEnablerSearchSession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsContactEnablerSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactEnablerSearch()` and `supportsVisibleFederation()` are `true.`
Method	getContactEnablerAdminSession
Description	Gets the `OsidSession` associated with the contact enabler administration service.
Return	`osid.contact.rules.ContactEnablerAdminSession`		a `ContactEnablerAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsContactEnablerAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactEnablerAdmin()` is `true.`
Method	getContactEnablerAdminSessionForAddressBook
Description	Gets the `OsidSession` associated with the contact enabler administration service for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Return	`osid.contact.rules.ContactEnablerAdminSession`		a `ContactEnablerAdminSession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsContactEnablerAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactEnablerAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getContactEnablerNotificationSession
Description	Gets the `OsidSession` associated with the contact enabler notification service.
Parameters	`osid.contact.rules.ContactEnablerReceiver`	`contactEnablerReceiver`	the notification callback
Return	`osid.contact.rules.ContactEnablerNotificationSession`		a `ContactEnablerNotificationSession`
Errors	NULL_ARGUMENT		`contactEnablerReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsContactEnablerNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactEnablerNotification()` is `true.`
Method	getContactEnablerNotificationSessionForAddressBook
Description	Gets the `OsidSession` associated with the contact enabler notification service for the given address book.
Parameters	`osid.contact.rules.ContactEnablerReceiver`	`contactEnablerReceiver`	the notification callback
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Return	`osid.contact.rules.ContactEnablerNotificationSession`		a `ContactEnablerNotificationSession`
Errors	NOT_FOUND		no address book found by the given `Id`
	NULL_ARGUMENT		`contactEnablerReceiver` or `addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsContactEnablerNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactEnablerNotification()` and `supportsVisibleFederation()` are `true.`
Method	getContactEnablerAddressBookSession
Description	Gets the `OsidSession` to lookup contact enabler/address book mappings for contact enablers.
Return	`osid.contact.rules.ContactEnablerAddressBookSession`		a `ContactEnablerAddressBookSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsContactEnablerAddressBook()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactEnablerAddressBook()` is `true.`
Method	getContactEnablerAddressBookAssignmentSession
Description	Gets the `OsidSession` associated with assigning contact enablers to address books for contact.
Return	`osid.contact.rules.ContactEnablerAddressBookAssignmentSession`		a `ContactEnablerAddressBookAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsContactEnablerAddressBookAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactEnablerAddressBookAssignment()` is `true.`
Method	getContactEnablerSmartAddressBookSession
Description	Gets the `OsidSession` to manage contact enabler smart address books.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Return	`osid.contact.rules.ContactEnablerSmartAddressBookSession`		a `ContactEnablerSmartAddressBookSession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsContactEnablerSmartAddressBook()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactEnablerSmartAddressBook()` is `true.`
Method	getContactEnablerRuleLookupSession
Description	Gets the `OsidSession` associated with the contact enabler mapping lookup service.
Return	`osid.contact.rules.ContactEnablerRuleLookupSession`		a `ContactEnablertRuleLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsContactEnablerRuleLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactEnablerRuleLookup()` is `true.`
Method	getContactEnablerRuleLookupSessionForAddressBook
Description	Gets the `OsidSession` associated with the contact enabler mapping lookup service for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Return	`osid.contact.rules.ContactEnablerRuleLookupSession`		a `ContactEnablerRuleLookupSession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsContactEnablerRuleLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactEnablerRuleLookup()` and `supportsVisibleFederation()` are `true.`
Method	getContactEnablerRuleApplicationSession
Description	Gets the `OsidSession` associated with the contact enabler assignment service to apply enablers.
Return	`osid.contact.rules.ContactEnablerRuleApplicationSession`		a `ContactEnablerRuleApplicationSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsContactEnablerRuleApplication()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactEnablerRuleApplication()` is `true.`
Method	getContactEnablerRuleApplicationSessionForAddressBook
Description	Gets the `OsidSession` associated with the contact enabler assignment service for the given address book to apply enablers.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Return	`osid.contact.rules.ContactEnablerRuleApplicationSession`		a `ContactEnablerRuleApplicationSession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsContactEnablerRuleApplication()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactEnablerRuleApplication()` and `supportsVisibleFederation()` are `true.`