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

Interface	osid.contact.rules.ContactEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `ContactEnablers.` This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated address book view: All contact enabler methods in this session operate, retrieve and pertain to contact enablers defined explicitly in the current address book. Using an isolated view is useful for managing `ContactEnablers` with the `ContactEnablerAdminSession.` federated address book view: All contact enabler 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. active contact enabler view: All contact enabler lookup methods return active contact enablers. any status contact enabler view: Contact enablers of any active or inactive status are returned from methods. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedDistributorView()` and `useIsolatedDistributorView()` behave as a radio group and one should be selected before invoking the methods in this session.
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	canLookupContactEnablers
Description	Tests if this user can perform `ContactEnablers` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeContactEnablerView
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	usePlenaryContactEnablerView
Description	A complete view of the `ContactEnabler` 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	useActiveContactEnablerView
Description	Only actuve contact enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusContactEnablerView
Description	All active and inactive contact enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getContactEnabler
Description	Gets the `ContactEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `ContactEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `ContactEnabler` and retained for compatibility. In active mode, contact enablers are returned that are currently active. In any status mode, active and inactive contact enablers are returned.
Parameters	`osid.id.Id`	`contactEnablerId`	`Id` of the `ContactEnabler`
Return	`osid.contact.rules.ContactEnabler`		the contact enabler
Errors	NOT_FOUND		`contactEnablerId` not found
	NULL_ARGUMENT		`contactEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getContactEnablersByIds
Description	Gets a `ContactEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the contact enablers specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `ContactEnablers` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`contactEnablerIds`	the list of `Ids` to retrieve
Return	`osid.contact.rules.ContactEnablerList`		the returned `ContactEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`contactEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactEnablersByGenusType
Description	Gets a `ContactEnablerList` corresponding to the given contact enabler genus `Type` which does not include contact enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known contact enablers or an error results. Otherwise, the returned list may contain only those contact enablers that are accessible through this session. In active mode, contact enablers are returned that are currently active. In any status mode, active and inactive contact enablers are returned.
Parameters	`osid.type.Type`	`contactEnablerGenusType`	a contact enabler genus type
Return	`osid.contact.rules.ContactEnablerList`		the returned `ContactEnabler` list
Errors	NULL_ARGUMENT		`contactEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactEnablersByParentGenusType
Description	Gets a `ContactEnablerList` corresponding to the given contact enabler genus `Type` and include any additional contact enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known contact enablers or an error results. Otherwise, the returned list may contain only those contact enablers that are accessible through this session. In active mode, contact enablers are returned that are currently active. In any status mode, active and inactive contact enablers are returned.
Parameters	`osid.type.Type`	`contactEnablerGenusType`	a contact enabler genus type
Return	`osid.contact.rules.ContactEnablerList`		the returned `ContactEnabler` list
Errors	NULL_ARGUMENT		`contactEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactEnablersByRecordType
Description	Gets a `ContactEnablerList` containing the given contact enabler record `Type.` In plenary mode, the returned list contains all known contact enablers or an error results. Otherwise, the returned list may contain only those contact enablers that are accessible through this session. In active mode, contact enablers are returned that are currently active. In any status mode, active and inactive contact enablers are returned.
Parameters	`osid.type.Type`	`contactEnablerRecordType`	a contact enabler record type
Return	`osid.contact.rules.ContactEnablerList`		the returned `ContactEnabler` list
Errors	NULL_ARGUMENT		`contactEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactEnablersOnDate
Description	Gets a `ContactEnablerList` which are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known contact enablers or an error results. Otherwise, the returned list may contain only those contact enablers that are accessible through this session. In active mode, contact enablers are returned that are currently active. In any status mode, active and inactive contact enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.contact.rules.ContactEnablerList`		the returned `ContactEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactEnablersOnDateWithAgent
Description	Gets a `ContactEnablerList` which are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known contact enablers or an error results. Otherwise, the returned list may contain only those contact enablers that are accessible through this session. In active mode, contact enablers are returned that are currently active. In any status mode, active and inactive contact enablers are returned.
Parameters	`osid.id.Id`	`agentId`	an agent Id
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.contact.rules.ContactEnablerList`		the returned `ContactEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agent, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactEnablers
Description	Gets all `ContactEnablers.` In plenary mode, the returned list contains all known contact enablers or an error results. Otherwise, the returned list may contain only those contact enablers that are accessible through this session. In active mode, contact enablers are returned that are currently active. In any status mode, active and inactive contact enablers are returned.
Return	`osid.contact.rules.ContactEnablerList`		the returned `ContactEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.