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

Interface	osid.contact.rules.ContactEnablerAddressBookAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.contact.rules.ContactRulesManager`
Used By	`osid.contact.rules.ContactRulesProxyManager`
Description	This session provides methods to re-assign `ContactEnabler` to `AddressBook` mappings. A `ContactEnabler` may appear in multiple `AddressBook` objects and removing the last reference to a `ContactEnabler` 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 `ContactEnabler` to another `AddressBook` is not a copy operation (eg: does not change its `Id`).
Method	canAssignContactEnablers
Description	Tests if this user can alter contact enabler/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 lookup operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignContactEnablersToAddressBook
Description	Tests if this user can alter contact enabler/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 lookup 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 enabler 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	getAssignableAddressBookIdsForContactEnabler
Description	Gets a list of address books including and under the given address book node in which a specific contact enabler can be assigned.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Parameters	`osid.id.Id`	`contactEnablerId`	the `Id` of the `ContactEnabler`
Return	`osid.id.IdList`		list of assignable address book `Ids`
Errors	NULL_ARGUMENT		`addressBookId` or `contactEnablerId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignContactEnablerToAddressBook
Description	Adds an existing `ContactEnabler` to an `AddressBook`.
Parameters	`osid.id.Id`	`contactEnablerId`	the `Id` of the `ContactEnabler`
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Errors	ALREADY_EXISTS		`contactEnablerId` is already assigned to `addressBookId`
	NOT_FOUND		`contactEnablerId` or `addressBookId` not found
	NULL_ARGUMENT		`contactEnablerId` or `addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignContactEnablerFromAddressBook
Description	Removes a `ContactEnabler` from an `AddressBook`.
Parameters	`osid.id.Id`	`contactEnablerId`	the `Id` of the `ContactEnabler`
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook`
Errors	NOT_FOUND		`contactEnablerId` or `addressBookId` not found or `contactEnablerId` is not assigned to `addressBookId`
	NULL_ARGUMENT		`contactEnablerId` or `addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignContactEnablerToAddressBook
Description	Moves a `ContactEnabler` from one `AddressBook` to another. Mappings to other `AddressBooks` are unaffected.
Parameters	`osid.id.Id`	`contactEnablerId`	the `Id` of the `ContactEnabler`
	`osid.id.Id`	`fromAddressBookId`	the `Id` of the current `AddressBook`
	`osid.id.Id`	`toAddressBookId`	the `Id` of the destination `AddressBook`
Errors	ALREADY_EXISTS		`contactEnablerId` already assigned to `toAddressBookId`
	NOT_FOUND		`contactEnablerId, fromAddressBookId`, or `toAddressBookId` not found or `contactEnablerId` not mapped to `fromAddressBookId`
	NULL_ARGUMENT		`contactEnablerId, fromAddressBookId`, or `toAddressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.