OSID - osid.contact.ContactManager Service Interface Definition

Interface	osid.contact.ContactManager
Implements	`osid.OsidManager`
Implements	`osid.contact.ContactProfile`
Used By	`osid.orchestration.OrchestrationManager`
Description	The contact manager provides access to contact sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `ContactSession`: a session to get available contacts for a resource `ContactLookupSession`: a session to lookup contacts `ContactQuerySession`: a session to query contacts `ContactSearchSession`: a session to search contacts `ContactAdminSession`: a session to manage contacts `ContactNotificationSession`: a session to subscribe to notifications of contact changes `ContactAddressBookSession`: a session to lookup contact address book mappings `ContactAddressBookAssignmentSession`: a session to manage contact address book mappings `ContactSmartAddressBookSession`: a session to manage smart address books of contacts `AddressLookupSession`: a session to retrieve addresses `AddressQuerySession`: a session to query addresses `AddressSearchSession`: a session to search for addresses `AddressAdminSession`: a session to create, update and delete addresses `AddressNotificationSession`: a session to receive notifications for changes in addresses `AddressAddressBookSession`: a session to lookup address address book mappings `AddressAddressBookAssignmentSession`: a session to manage address address book mappings `AddressSmartAddressBookSession`: a session to manage smart address books of addresses `AddressBookLookupSession`: a session to retrieve address books `AddressBookQuerySession`: a session to query address books `AddressBookSearchSession`: a session to search for address books `AddressBookAdminSession`: a session to create, update and delete address books `AddressBookNotificationSession`: a session to receive notifications for changes in address books `AddressBookHierarchyTraversalSession`: a session to traverse hierarchies of address books `AddressBookHierarchyDesignSession`: a session to manage hierarchies of address books The contact manager also provides a profile for determing the supported search types supported by this service.
Method	getContactSession
Description	Gets the `OsidSession` associated with the contact service.
Return	`osid.contact.ContactSession`		a `ContactSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsContact()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContact()` is `true`.
Method	getContactSessionForAddressBook
Description	Gets the `OsidSession` associated with the contact service for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Return	`osid.contact.ContactSession`		a `ContactSession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsContact()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContact()` and `supportsVisibleFederation()` are `true`
Method	getContactLookupSession
Description	Gets the `OsidSession` associated with the contact lookup service.
Return	`osid.contact.ContactLookupSession`		a `ContactLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsContactLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactLookup()` is `true`.
Method	getContactLookupSessionForAddressBook
Description	Gets the `OsidSession` associated with the contact lookup service for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Return	`osid.contact.ContactLookupSession`		a `ContactLookupSession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsContactLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactLookup()` and `supportsVisibleFederation()` are `true`
Method	getContactQuerySession
Description	Gets the `OsidSession` associated with the contact query service.
Return	`osid.contact.ContactQuerySession`		a `ContactQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsContactQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactQuery()` is `true`.
Method	getContactQuerySessionForAddressBook
Description	Gets the `OsidSession` associated with the contact query service for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Return	`osid.contact.ContactQuerySession`		a `ContactQuerySession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsContactQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactQuery()` and `supportsVisibleFederation()` are `true`
Method	getContactSearchSession
Description	Gets the `OsidSession` associated with the contact search service.
Return	`osid.contact.ContactSearchSession`		a `ContactSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsContactSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactSearch()` is `true`.
Method	getContactSearchSessionForAddressBook
Description	Gets the `OsidSession` associated with the contact search service for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Return	`osid.contact.ContactSearchSession`		a `ContactSearchSession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsContactSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactSearch()` and `supportsVisibleFederation()` are `true`
Method	getContactAdminSession
Description	Gets the `OsidSession` associated with the contact administration service.
Return	`osid.contact.ContactAdminSession`		a `ContactAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsContactAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactAdmin()` is `true`.
Method	getContactAdminSessionForAddressBook
Description	Gets the `OsidSession` associated with the contact administration service for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Return	`osid.contact.ContactAdminSession`		a `ContactAdminSession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsContactAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactAdmin()` and `supportsVisibleFederation()` are `true`
Method	getContactNotificationSession
Description	Gets the `OsidSession` associated with the contact notification service.
Parameters	`osid.contact.ContactReceiver`	`contactReceiver`	the receiver
Return	`osid.contact.ContactNotificationSession`		a `ContactNotificationSession`
Errors	NULL_ARGUMENT		`contactReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsContactNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactNotification()` is `true`.
Method	getContactNotificationSessionForAddressBook
Description	Gets the `OsidSession` associated with the contact notification service for the given address book.
Parameters	`osid.contact.ContactReceiver`	`contactReceiver`	the receiver
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Return	`osid.contact.ContactNotificationSession`		a `ContactNotificationSession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`contactReceiver` or `addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsContactNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactNotification()` and `supportsVisibleFederation()` are `true`
Method	getContactAddressBookSession
Description	Gets the session for retrieving contact to address book mappings.
Return	`osid.contact.ContactAddressBookSession`		a `ContactAddressBookSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsContactAddressBook()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactAddressBook()` is `true`.
Method	getContactAddressBookAssignmentSession
Description	Gets the session for assigning contact to address book mappings.
Return	`osid.contact.ContactAddressBookAssignmentSession`		a `ContactAddressBookAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsContactAddressBookAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactAddressBookAssignment()` is `true`.
Method	getContactSmartAddressBookSession
Description	Gets the session associated with the contact smart address book for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the contact book
Return	`osid.contact.ContactSmartAddressBookSession`		a `ContactSmartAddressBookSession`
Errors	NOT_FOUND		`contactBookId` not found
	NULL_ARGUMENT		`contactBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsContactSmartAddressBook()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactSmartAddressBook()` is `true`.
Method	getAddressLookupSession
Description	Gets the `OsidSession` associated with the address lookup service.
Return	`osid.contact.AddressLookupSession`		an `AddressLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAddressLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressLookup()` is `true`.
Method	getAddressLookupSessionForAddressBook
Description	Gets the `OsidSession` associated with the address lookup service for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `Address`
Return	`osid.contact.AddressLookupSession`		an `AddressLookupSession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAddressLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressLookup()` and `supportsVisibleFederation()` are `true`
Method	getAddressQuerySession
Description	Gets the `OsidSession` associated with the address query service.
Return	`osid.contact.AddressQuerySession`		an `AddressQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAddressQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressQuery()` is `true`.
Method	getAddressQuerySessionForAddressBook
Description	Gets the `OsidSession` associated with the address query service for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `Address`
Return	`osid.contact.AddressQuerySession`		an `AddressQuerySession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAddressQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressQuery()` and `supportsVisibleFederation()` are `true`
Method	getAddressSearchSession
Description	Gets the `OsidSession` associated with the address search service.
Return	`osid.contact.AddressSearchSession`		an `AddressSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAddressSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressSearch()` is `true`.
Method	getAddressSearchSessionForAddressBook
Description	Gets the `OsidSession` associated with the address search service for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `Address`
Return	`osid.contact.AddressSearchSession`		an `AddressSearchSession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAddressSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressSearch()` and `supportsVisibleFederation()` are `true`
Method	getAddressAdminSession
Description	Gets the `OsidSession` associated with the address administrative service.
Return	`osid.contact.AddressAdminSession`		an `AddressAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAddressAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressAdmin()` is `true`.
Method	getAddressAdminSessionForAddressBook
Description	Gets the `OsidSession` associated with the address administrative service for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `Address`
Return	`osid.contact.AddressAdminSession`		an `AddressAdminSession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAddressAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressAdmin()` and `supportsVisibleFederation()` are `true`
Method	getAddressNotificationSession
Description	Gets the `OsidSession` associated with the address notification service.
Parameters	`osid.contact.AddressReceiver`	`addressReceiver`	the receiver
Return	`osid.contact.AddressNotificationSession`		an `AddressNotificationSession`
Errors	NULL_ARGUMENT		`addressReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAddressNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressNotification()` is `true`.
Method	getAddressNotificationSessionForAddressBook
Description	Gets the `OsidSession` associated with the address notification service for the given address book.
Parameters	`osid.contact.AddressReceiver`	`addressReceiver`	the receiver
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Return	`osid.contact.AddressNotificationSession`		an `AddressNotificationSession`
Errors	NOT_FOUND		no `AddressBook` found by the given `Id`
	NULL_ARGUMENT		`addressReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAddressNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressNotification()` and `supportsVisibleFederation()` are `true`
Method	getAddressAddressBookSession
Description	Gets the session for retrieving address to address book mappings.
Return	`osid.contact.AddressAddressBookSession`		an `AddressAddressBookSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAddressAddressBook()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressAddressBook()` is `true`.
Method	getAddressAddressBookAssignmentSession
Description	Gets the session for assigning address to address book mappings.
Return	`osid.contact.AddressAddressBookAssignmentSession`		an `AddressAddressBookAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAddressAddressBookAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressAddressBookAssignment()` is `true`.
Method	getAddressSmartAddressBookSession
Description	Gets the session associated with the address smart address book for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the address book
Return	`osid.contact.AddressSmartAddressBookSession`		an `AddressSmartAddressBookSession`
Errors	NOT_FOUND		`addressBookId` not found
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAddressSmartAddressBook()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressSmartAddressBook()` is `true`.
Method	getAddressBookLookupSession
Description	Gets the `OsidSession` associated with the address book lookup service.
Return	`osid.contact.AddressBookLookupSession`		an `AddressBookLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAddressBookLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressBookLookup()` is `true`.
Method	getAddressBookQuerySession
Description	Gets the `OsidSession` associated with the address book query service.
Return	`osid.contact.AddressBookQuerySession`		an `AddressBookQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAddressBookQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressBookQuery()` is `true`.
Method	getAddressBookSearchSession
Description	Gets the `OsidSession` associated with the address book search service.
Return	`osid.contact.AddressBookSearchSession`		an `AddressBookSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAddressBookSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressBookSearch()` is `true`.
Method	getAddressBookAdminSession
Description	Gets the `OsidSession` associated with the address book administrative service.
Return	`osid.contact.AddressBookAdminSession`		an `AddressBookAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAddressBookAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressBookAdmin()` is `true`.
Method	getAddressBookNotificationSession
Description	Gets the `OsidSession` associated with the address book notification service.
Parameters	`osid.contact.AddressBookReceiver`	`addressBookReceiver`	the receiver
Return	`osid.contact.AddressBookNotificationSession`		an `AddressBookNotificationSession`
Errors	NULL_ARGUMENT		`addressBookReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAddressBookNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressBookNotification()` is `true`.
Method	getAddressBookHierarchySession
Description	Gets the `OsidSession` associated with the address book hierarchy service.
Return	`osid.contact.AddressBookHierarchySession`		an `AddressBookHierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAddressBookHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressBookHierarchy()` is `true`.
Method	getAddressBookHierarchyDesignSession
Description	Gets the `OsidSession` associated with the address book hierarchy design service.
Return	`osid.contact.AddressBookHierarchyDesignSession`		an `AddressBookHierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAddressBookHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressBookHierarchyDesign()` is `true`.
Method	getContactBatchManager
Description	Gets the `ContactBatchManager`.
Return	`osid.contact.batch.ContactBatchManager`		a `ContactBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsContactBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactBatch()` is `true`.
Method	getContactRulesManager
Description	Gets the `ContactRulesManager`.
Return	`osid.contact.rules.ContactRulesManager`		a `ContactRulesManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsContactRules()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContactRules()` is `true`.