OSID - osid.contact.ContactSession Service Interface Definition

Interface	osid.contact.ContactSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving contacts. This lookup session defines several views: isolated address book view: All contact methods in this session operate, retrieve and pertain to contacts defined explicitly in the current address book. Using an isolated view is useful for managing contacts with the `ContactAdminSession.` federated address book view: All contact lookup methods in this session operate, retrieve and pertain to all contacts defined in this address book and any other address books implicitly available in this address book through address book inheritence. The methods `useFederatedAddressBookView()` and `useIsolatedAddressBookView()` behave as a radio group and one should be selected before invoking any lookup methods. This session is always in comparative mode.
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	canGetContacts
Description	Tests if this user can lookup contacts. 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 these operations.
Return	`boolean`		`false` if contact lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedAddressBookView
Description	Federates the view for methods in this session. A federated view will include contacts 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	getAvailableContacts
Description	Gets a list of all current available contacts corresponding to a reference `Id` sorted from highlest to lowest priority.
Parameters	`osid.id.Id`	`referenceId`	the `Id` of the reference
Return	`osid.contact.ContactList`		the returned `ContactList`
Errors	NULL_ARGUMENT		`referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAvailableContactsByGenusType
Description	Gets all current available contacts for a reference and by contact genus `Type` sorted from highest to lowest priority.
Parameters	`osid.id.Id`	`referenceId`	the `Id` of the reference
Parameters	`osid.type.Type`	`contactGenusType`	a contact genus `Type`
Return	`osid.contact.ContactList`		a list of contacts
Errors	NULL_ARGUMENT		`referenceId` or `contactGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.