OSID - osid.contact.ContactAddressBookAssignmentSession Service Interface Definition

Interface	osid.contact.ContactAddressBookAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.contact.ContactManager`
Used By	`osid.contact.ContactProxyManager`
Description	This session provides methods to re-assign `Contacts` to `AddressBooks`. A `Contact` may map to multiple `AddressBooks` and removing the last reference to a `Contact` is the equivalent of deleting it. Each `AddressBook` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `Contact` to another `AddressBook` is not a copy operation (eg: does not change its `Id`).
Method	canAssignContacts
Description	Tests if this user can alter contact/address book mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignContactsToAddressBook
Description	Tests if this user can alter contact/address book mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`addressBookId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableAddressBookIds
Description	Gets a list of address books including and under the given address book node in which any contact can be assigned.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Return	`osid.id.IdList`		list of assignable address book `Ids`
Errors	NULL_ARGUMENT		`addressBookId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableAddressBookIdsForContact
Description	Gets a list of address books including and under the given address book node in which a specific contact can be assigned.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Parameters	`osid.id.Id`	`contactId`	the `Id` of the `Contact`
Return	`osid.id.IdList`		list of assignable address book `Ids`
Errors	NULL_ARGUMENT		`addressBookId` or `contactId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignContactToAddressBook
Description	Adds an existing `Contact` to an `AddressBook`.
Parameters	`osid.id.Id`	`contactId`	the `Id` of the `Contact`
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Errors	ALREADY_EXISTS		`contactId` is already assigned to `addressBookId`
	NOT_FOUND		`contactId` or `addressBookId` not found
	NULL_ARGUMENT		`contactId` or `addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignContactFromAddressBook
Description	Removes a `Contact` from an `AddressBook`.
Parameters	`osid.id.Id`	`contactId`	the `Id` of the `Contact`
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Errors	NOT_FOUND		`contactId` or `addressBookId` not found or `contactId` not assigned to `addressBookId`
	NULL_ARGUMENT		`contactId` or `addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignContactToAddressBook
Description	Moves a `Contact` from one `AddressBook` to another. Mappings to other `AddressBooks` are unaffected.
Parameters	`osid.id.Id`	`contactId`	the `Id` of the `Contact`
	`osid.id.Id`	`fromAddressBookId`	the `Id` of the current `AddressBook`
	`osid.id.Id`	`toAddressBookId`	the `Id` of the destination `AddressBook`
Errors	ALREADY_EXISTS		`contactId` already assigned to `toAddressBookId`
	NOT_FOUND		`contactId, fromAddressBookId`, or `toAddressBookId` not found or `contactId` not mapped to `fromAddressBookId`
	NULL_ARGUMENT		`contactId, fromAddressBookId`, or `toAddressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.