OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.AddressBookLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving AddressBook objects. The AddressBook 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 set or is an error condition
MethodcanLookupAddressBooks
Description

Tests if this user can perform AddressBook 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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeAddressBookView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryAddressBookView
Description

A complete view of the AddressBook 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.

CompliancemandatoryThis method is must be implemented.
MethodgetAddressBook
Description

Gets the AddressBook specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned AddressBook may have a different Id than requested, such as the case where a duplicate Id was assigned to an AddressBook and retained for compatibility.

Parametersosid.id.IdjouralId Id of the AddressBook
Returnosid.contact.AddressBookthe address book
ErrorsNOT_FOUND addressBookId not found
NULL_ARGUMENT addressBookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetAddressBooksByIds
Description

Gets an AddressBookList corresponding to the given IdList. In plenary mode, the returned list contains all of the address books 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 AddressBooks may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListaddressBookIdsthe list of Ids to retrieve
Returnosid.contact.AddressBookListthe returned AddressBook list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT addressBookIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAddressBooksByGenusType
Description

Gets an AddressBookList corresponding to the given address book genus Type which does not include address books of genus types derived from the specified Type. In plenary mode, the returned list contains all known address books or an error results. Otherwise, the returned list may contain only those address books that are accessible through this session.

Parametersosid.type.TypeaddressBookGenusTypean address book genus type
Returnosid.contact.AddressBookListthe returned AddressBook list
ErrorsNULL_ARGUMENT addressBookGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAddressBooksByParentGenusType
Description

Gets an AddressBookList corresponding to the given address book genus Type and include any additional address books with genus types derived from the specified Type. In plenary mode, the returned list contains all known address books or an error results. Otherwise, the returned list may contain only those address books that are accessible through this session.

Parametersosid.type.TypeaddressBookGenusTypean address book genus type
Returnosid.contact.AddressBookListthe returned AddressBook list
ErrorsNULL_ARGUMENT addressBookGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAddressBooksByRecordType
Description

Gets an AddressBookList containing the given address book record Type. In plenary mode, the returned list contains all known address books or an error results. Otherwise, the returned list may contain only those address books that are accessible through this session.

Parametersosid.type.TypeaddressBookRecordTypean address book record type
Returnosid.contact.AddressBookListthe returned AddressBook list
ErrorsNULL_ARGUMENT addressBookRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAddressBooksByProvider
Description

Gets an AddressBookList from the given provider. In plenary mode, the returned list contains all known address books or an error results. Otherwise, the returned list may contain only those address books that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.contact.AddressBookListthe returned AddressBook list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAddressBooks
Description

Gets all AddressBooks. In plenary mode, the returned list contains all known address books or an error results. Otherwise, the returned list may contain only those address books that are accessible through this session.

Returnosid.contact.AddressBookLista list of AddressBooks
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.