OSID - osid.contact.AddressLookupSession Service Interface Definition

Interface	osid.contact.AddressLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Address` objects. The `Address` represents a collection of contacts. 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 view or is an error condition isolated address book view: All address methods in this session operate, retrieve and pertain to addresses defined explicitly in the current address book. Using an isolated view is useful for managing addresses with the `AddressAdminSession.` federated address book view: All address lookup methods in this session operate, retrieve and pertain to all addresses defined in this address book and any other address books 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	canLookupAddresses
Description	Tests if this user can perform `Address` 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 not 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	useComparativeAddressView
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	usePlenaryAddressView
Description	A complete view of the `Address` 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 addresses 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 retrievals to this address book only.
Compliance	`mandatory`		This method is must be implemented.
Method	getAddress
Description	Gets the `Address` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Address` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Address` and retained for compatibility.
Parameters	`osid.id.Id`	`addressId`	`Id` of the `Address`
Return	`osid.contact.Address`		the address
Errors	NOT_FOUND		`addressId` not found
	NULL_ARGUMENT		`addressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getAddressesByIds
Description	Gets an `AddressList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the addresses 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 `Addresses` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`addressIds`	the list of `Ids` to retrieve
Return	`osid.contact.AddressList`		the returned `Address` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`addressIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAddressesByGenusType
Description	Gets an `AddressList` corresponding to the given address genus `Type` which does not include addresses of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known addresses or an error results. Otherwise, the returned list may contain only those addresses that are accessible through this session.
Parameters	`osid.type.Type`	`addressGenusType`	an address genus type
Return	`osid.contact.AddressList`		the returned `Address` list
Errors	NULL_ARGUMENT		`addressGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAddressesByParentGenusType
Description	Gets an `AddressList` corresponding to the given address genus `Type` and include any additional addresses with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known addresses or an error results. Otherwise, the returned list may contain only those addresses that are accessible through this session.
Parameters	`osid.type.Type`	`addressGenusType`	an address genus type
Return	`osid.contact.AddressList`		the returned `Address` list
Errors	NULL_ARGUMENT		`addressGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAddressesByRecordType
Description	Gets an `AddressList` containing the given address record `Type.` In plenary mode, the returned list contains all known addresses or an error results. Otherwise, the returned list may contain only those addresses that are accessible through this session.
Parameters	`osid.type.Type`	`addressRecordType`	an address record type
Return	`osid.contact.AddressList`		the returned `Address` list
Errors	NULL_ARGUMENT		`addressRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAddressesByResource
Description	Gets an `AddressList` for the given resource. In plenary mode, the returned list contains all known addresses or an error results. Otherwise, the returned list may contain only those addresses that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.contact.AddressList`		the returned `Address` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAddresses
Description	Gets all `Addresses.` In plenary mode, the returned list contains all known addresses or an error results. Otherwise, the returned list may contain only those addresses that are accessible through this session.
Return	`osid.contact.AddressList`		a list of `Addresses`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.