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

Interface	osid.contact.rules.ContactEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Description	This session provides methods to apply `ContactEnablers` to `Contacts.` A `Contact` with multiple `ContactEnablers` means any positive rule evaluation across the enablers result in an effective `Contact.`
Method	getAddressBookId
Description	Gets the `AddressBook` `Id` associated with this session.
Return	`osid.id.Id`		the `AddressBook Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAddressBook
Description	Gets the `AddressBook` associated with this session.
Return	`osid.contact.AddressBook`		the address book
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAssignContactEnablers
Description	Tests if this user can alter contact enabler/contact 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	assignContactEnablerToContact
Description	Adds an existing `ContactEnabler` to a `Contact.`
Parameters	`osid.id.Id`	`contactEnablerId`	the `Id` of the `ContactEnabler`
Parameters	`osid.id.Id`	`contactId`	the `Id` of the `Contact`
Errors	ALREADY_EXISTS		`contactEnablerId` is already applied to `contactId`
	NOT_FOUND		`contactEnablerId` or `contactId` not found
	NULL_ARGUMENT		`contactEnablerId` or `contactId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignContactEnablerFromContact
Description	Removes a `ContactEnabler` from a `Contact.`
Parameters	`osid.id.Id`	`contactEnablerId`	the `Id` of the `ContactEnabler`
Parameters	`osid.id.Id`	`contactId`	the `Id` of the `Contact`
Errors	NOT_FOUND		`contactEnablerId` or `contactId` not found or `contactEnablerId` is not applied to `contactId`
	NULL_ARGUMENT		`contactEnablerId` or `contactId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceContactEnablers
Description	Tests if this user can order `ContactEnablers.` A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `ContactEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveContactEnablerAhead
Description	Reorders contact enablers for a contact by moving the specified contact enabler in front of a reference contact enabler.
Parameters	`osid.id.Id`	`contactEnablerId`	the `Id` of a `ContactEnabler`
	`osid.id.Id`	`contactId`	the `Id` of a `Contact`
	`osid.id.Id`	`referenceId`	the reference contact enabler `Id`
Errors	NOT_FOUND		`contactEnabelrId, contactId,` or `referenceId` not found or, `contactEnablerId` or `referenceId` not related to `contactId`
	NULL_ARGUMENT		`contactEnablerId, contactId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveContactEnablerBehind
Description	Reorders contact enablers for a contact by moving the specified contact enabler behind a reference contact enabler.
Parameters	`osid.id.Id`	`contactEnablerId`	the `Id` of a `ContactEnabler`
	`osid.id.Id`	`contactId`	the `Id` of a `Contact`
	`osid.id.Id`	`referenceId`	the reference contact enabler `Id`
Errors	NOT_FOUND		`contactEnabelrId, contactId,` or `referenceId` not found or, `contactEnablerId` or `referenceId` not related to `contactId`
	NULL_ARGUMENT		`contactEnablerId, contactId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderContactEnablers
Description	Reorders a set of contact enablers for a contact.
Parameters	`osid.id.Id[]`	`contactEnablerId`	the `Ids` for a set of `ContactEnablers`
Parameters	`osid.id.Id`	`contactId`	the `Id` of a `Contact`
Errors	NOT_FOUND		`contactId` not found or, a `contactEnablerId` not related to `contactId`
	NULL_ARGUMENT		`contactEnablerIds` or `contactId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.