OSID - osid.contact.ContactLookupSession Service Interface Definition

Interface	osid.contact.ContactLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving contacts. 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 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. effective contact view: All contact lookup methods return contacts where the current dates falls in between the effective dates inclusive. any effective contact view: Contacts of any effective date are returned. The methods `useFederatedAddressBookView()` and `useIsolatedAddressBookView()` behave as a radio group and one should be selected before invoking any lookup methods.
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	canLookupContacts
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	useComparativeContactView
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	usePlenaryContactView
Description	A complete view of the `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 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	useEffectiveContactView
Description	Only contacts whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveContactView
Description	All contacts of any effective dates are returned by all methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getContact
Description	Gets the `Contact` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Contact` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Contact` and retained for compatibility. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.id.Id`	`contactId`	the `Id` of the `Contact` to retrieve
Return	`osid.contact.Contact`		the returned `Contact`
Errors	NOT_FOUND		no `Contact` found with the given `Id`
	NULL_ARGUMENT		`contactId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactsByIds
Description	Gets a `ContactList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the contacts 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 contacts may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.id.IdList`	`contactIds`	the list of `Ids` to retrieve
Return	`osid.contact.ContactList`		the returned `Contact list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`contactIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactsByGenusType
Description	Gets a `ContactList` corresponding to the given contact genus `Type` which does not include contacts of genus types derived from the specified `Type.` In plenary mode, the returned list contains all of the contacts 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 contacts may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.type.Type`	`contactGenusType`	a contact genus type
Return	`osid.contact.ContactList`		the returned `Contact` list
Errors	NULL_ARGUMENT		`contactGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactsByParentGenusType
Description	Gets a `ContactList` corresponding to the given contact genus `Type` and include any additional contacts with genus types derived from the specified `Type.` In plenary mode, the returned list contains all of the contacts 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 contacts may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.type.Type`	`contactGenusType`	a contact genus type
Return	`osid.contact.ContactList`		the returned `Contact` list
Errors	NULL_ARGUMENT		`contactGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactsByRecordType
Description	Gets a `ContactList` containing the given contact record `Type.` In plenary mode, the returned list contains all of the contacts 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 contacts may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.type.Type`	`contactRecordType`	a contact record type
Return	`osid.contact.ContactList`		the returned `Contact` list
Errors	NULL_ARGUMENT		`contactRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactsOnDate
Description	Gets a list of contacts with an effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known contacts or an error results. Otherwise, the returned list may contain only those contacts that are accessible through this session. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	the starting date
Parameters	`osid.calendaring.DateTime`	`to`	the ending date
Return	`osid.contact.ContactList`		the returned `ContactList`
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	getContactsByGenusTypeOnDate
Description	Gets a list of contacts of a genus type and with an effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known contacts or an error results. Otherwise, the returned list may contain only those contacts that are accessible through this session. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.type.Type`	`contactGenusType`	a contact genus type
	`osid.calendaring.DateTime`	`from`	the starting date
	`osid.calendaring.DateTime`	`to`	the ending date
Return	`osid.contact.ContactList`		the returned `ContactList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`contactGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactsForReference
Description	Gets a list of contacts corresponding to a reference `Id.` In plenary mode, the returned list contains all known contacts or an error results. Otherwise, the returned list may contain only those contacts that are accessible through this session. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
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	getContactsForReferenceOnDate
Description	Gets a list of all contacts corresponding to a reference `Id` and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known contacts or an error results. Otherwise, the returned list may contain only those contacts that are accessible through this session. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.id.Id`	`referenceId`	a reference `Id`
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.contact.ContactList`		the returned `ContactList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`referenceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactsByGenusTypeForReference
Description	Gets a list of contacts of the given genus type corresponding to a reference `Id.` In plenary mode, the returned list contains all known contacts or an error results. Otherwise, the returned list may contain only those contacts that are accessible through this session. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.id.Id`	`referenceId`	the `Id` of the reference
Parameters	`osid.type.Type`	`contactGenusType`	the genus type of the contact
Return	`osid.contact.ContactList`		the returned `ContactList`
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.
Method	getContactsByGenusTypeForReferenceOnDate
Description	Gets a list of all contacts of the given genus type corresponding to a reference `Id` and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known contacts or an error results. Otherwise, the returned list may contain only those contacts that are accessible through this session. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.id.Id`	`referenceId`	a reference `Id`
	`osid.type.Type`	`contactGenusType`	the genus type of the contact
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.contact.ContactList`		the returned `ContactList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`referenceId, contactGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactsForAddress
Description	Gets a list of all contacts corresponding to an address `Id.` In plenary mode, the returned list contains all known contacts or an error results. Otherwise, the returned list may contain only those contacts that are accessible through this session. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.id.Id`	`addressId`	the `Id` of the address
Return	`osid.contact.ContactList`		the returned `ContactList`
Errors	NULL_ARGUMENT		`addressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactsForAddressOnDate
Description	Gets a list of all contacts corresponding to an address `Id` and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known contacts or an error results. Otherwise, the returned list may contain only those contacts that are accessible through this session. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.id.Id`	`addressId`	an address `Id`
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.contact.ContactList`		the returned `ContactList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`addressId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactsByGenusTypeForAddress
Description	Gets a list of all contacts of the given genus type corresponding to an address `Id.` In plenary mode, the returned list contains all known contacts or an error results. Otherwise, the returned list may contain only those contacts that are accessible through this session. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.id.Id`	`addressId`	the `Id` of the address
Parameters	`osid.type.Type`	`contactGenusType`	the genus type of the contact
Return	`osid.contact.ContactList`		the returned `ContactList`
Errors	NULL_ARGUMENT		`addressId` or `contactGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactsByGenusTypeForAddressOnDate
Description	Gets a list of all contacts of the given genus type corresponding to an address `Id` and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known contacts or an error results. Otherwise, the returned list may contain only those contacts that are accessible through this session. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.id.Id`	`addressId`	an address `Id`
	`osid.type.Type`	`contactGenusType`	the genus type of the contact
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.contact.ContactList`		the returned `ContactList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`addressId, contactGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactsForReferenceAndAddress
Description	Gets a list of all contacts corresponding to a reference and address `Id.` In plenary mode, the returned list contains all known contacts or an error results. Otherwise, the returned list may contain only those contacts that are accessible through this session. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.id.Id`	`referenceId`	the `Id` of the reference
Parameters	`osid.id.Id`	`addressId`	the `Id` of the address
Return	`osid.contact.ContactList`		the returned `ContactList`
Errors	NULL_ARGUMENT		`referenceId` or `addressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactsForReferenceAndAddressOnDate
Description	Gets a list of all contacts corresponding to a reference and address `Id` and effectiveduring the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known contacts or an error results. Otherwise, the returned list may contain only those contacts that are accessible through this session. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.id.Id`	`referenceId`	the `Id` of the reference
	`osid.id.Id`	`addressId`	an address `Id`
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.contact.ContactList`		the returned `ContactList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`referenceId, addressI, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactsByGenusTypeForReferenceAndAddress
Description	Gets a list of all contacts with the given genus type corresponding to a reference and address `Id.` In plenary mode, the returned list contains all known contacts or an error results. Otherwise, the returned list may contain only those contacts that are accessible through this session. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.id.Id`	`referenceId`	the `Id` of the reference
	`osid.id.Id`	`addressId`	the `Id` of the address
	`osid.type.Type`	`contactGenusType`	the genus type of the contact
Return	`osid.contact.ContactList`		the returned `ContactList`
Errors	NULL_ARGUMENT		`referenceId, addressId` or `contactGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContactsByGenusTypeForReferenceAndAddressOnDate
Description	Gets a list of all contacts with the given genus type corresponding to a reference and address `Id` and during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known contacts or an error results. Otherwise, the returned list may contain only those contacts that are accessible through this session. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Parameters	`osid.id.Id`	`referenceId`	the `Id` of the reference
	`osid.id.Id`	`addressId`	an address `Id`
	`osid.type.Type`	`contactGenusType`	the genus type of the contact
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.contact.ContactList`		the returned `ContactList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`referenceId, addressId, contactGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getContacts
Description	Gets all contacts. In plenary mode, the returned list contains all known contacts or an error results. Otherwise, the returned list may contain only those contacts that are accessible through this session. In effective mode, contacts are returned that are currently effective. In any effective mode, effective contacts and those currently expired are returned.
Return	`osid.contact.ContactList`		a list of contacts
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.