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

Interface	osid.contact.rules.ContactEnablerRuleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `ContactEnabler` to `Contact` mappings. A `Contact` with multiple `ContactEnablers` means any positive rule evaluation across the enablers result in an enabled `Contact.` This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated address book view: All methods in this session operate, retrieve and pertain contact enablers defined explicitly in the current address book federated address book view: All methods in this session operate, retrieve and pertain to all contact enablers defined in this address book and any other contact enablers implicitly available in this address book through address book inheritence.
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	canLookupContactEnablerRules
Description	Tests if this user can perform lookups of contact enabler/contact mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeContactEnablerRuleView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryContactEnablerRuleView
Description	A complete view of the `ContactEnabler` and `Contact` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedAddressBookView
Description	Federates the view for methods in this session. A federated view will include contact enablers in address books which are children of this address book in the address book hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedAddressBookView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this address book only.
Compliance	`mandatory`		This method is must be implemented.
Method	getContactEnablerIdsForContact
Description	Gets the `ContactEnabler Id` associated with a `Contact.`
Parameters	`osid.id.Id`	`contactId`	`Id` of the `Contact`
Return	`osid.id.IdList`		the contact enabler `Ids`
Errors	NOT_FOUND		`contactId` is not found
	NULL_ARGUMENT		`contactId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactEnablersForContact
Description	Gets the `ContactEnabler` associated with a `Contact.`
Parameters	`osid.id.Id`	`contactId`	`Id` of the `Contact`
Return	`osid.contact.rules.ContactEnablerList`		the contact enablers
Errors	NOT_FOUND		`contactId` is not found
	NULL_ARGUMENT		`contactId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactIdsForContactEnabler
Description	Gets the `COntact` `Ids` mapped to a `ContactEnabler.`
Parameters	`osid.id.Id`	`contactEnablerId`	`Id` of a `ContactEnabler`
Return	`osid.id.IdList`		list of contact `Ids`
Errors	NOT_FOUND		`contactEnablerId` is not found
	NULL_ARGUMENT		`contactEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactsForContactEnabler
Description	Gets the `Contacts` mapped to a `ContactEnabler.`
Parameters	`osid.id.Id`	`contactEnablerId`	`Id` of a `ContactEnabler`
Return	`osid.contact.ContactList`		list of contacts
Errors	NOT_FOUND		`contactEnablerId` is not found
	NULL_ARGUMENT		`contactEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.