OSID - osid.contact.AddressAddressBookAssignmentSession Service Interface Definition

Interface	osid.contact.AddressAddressBookAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.contact.ContactManager`
Used By	`osid.contact.ContactProxyManager`
Description	This session provides methods to re-assign `Addresses` to `AddressBooks` . An `Address` may map to multiple `AddressBooks` and removing the last reference to an `Address` 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 an `Address` to another `AddressBook` is not a copy operation (eg: does not change its `Id` ).
Method	canAssignAddresses
Description	Tests if this user can alter address/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	canAssignAddressesToAddressBook
Description	Tests if this user can alter address/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 address 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	getAssignableAddressBookIdsForAddress
Description	Gets a list of address books including and under the given address book node in which a specific address can be assigned.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Parameters	`osid.id.Id`	`addressId`	the `Id` of the `Address`
Return	`osid.id.IdList`		list of assignable address book `Ids`
Errors	NULL_ARGUMENT		`addressBookId` or `addressId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignAddressToAddressBook
Description	Adds an existing `Address` to an `AddressBook` .
Parameters	`osid.id.Id`	`addressId`	the `Id` of the `Address`
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Errors	ALREADY_EXISTS		`addressId` is already assigned to `addressBookId`
	NOT_FOUND		`addressId` or `addressBookId` not found
	NULL_ARGUMENT		`addressId` or `addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignAddressFromAddressBook
Description	Removes an `Address` from an `AddressBook` .
Parameters	`osid.id.Id`	`addressId`	the `Id` of the `Address`
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Errors	NOT_FOUND		`addressId` or `addressBookId` not found or `addressId` not assigned to `addressBookId`
	NULL_ARGUMENT		`addressId` or `addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignAddressToAddressBook
Description	Moves an `Address` from one `AddressBook` to another. Mappings to other `AddressBooks` are unaffected.
Parameters	`osid.id.Id`	`addressId`	the `Id` of the `Address`
	`osid.id.Id`	`fromAddressBookId`	the `Id` of the current `AddressBook`
	`osid.id.Id`	`toAddressBookId`	the `Id` of the destination `AddressBook`
Errors	ALREADY_EXISTS		`addressId` already assigned to `toAddressBookId`
	NOT_FOUND		`addressId, fromAddressBookId` , or `toAddressBookId` not found or `addressId` not mapped to `fromAddressBookId`
	NULL_ARGUMENT		`addressId, fromAddressBookId` , or `toAddressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.