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

This session provides methods for searching AddressBook objects. The search query is constructed using the AddressBookQuery. The address book record Type also specifies the record for the address book query.

AddressBooks may have a query record indicated by their respective record types. The query record is accessed via the AddressBookQuery. The returns in this session may not be cast directly to these interfaces.

MethodcanSearchAddressBooks
Description

Tests if this user can perform AddressBook searches. 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 search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAddressBookQuery
Description

Gets an address book query.

Returnosid.contact.AddressBookQuerythe address book query
CompliancemandatoryThis method must be implemented.
MethodgetAddressBooksByQuery
Description

Gets a list of AddressBooks matching the given search.

Parametersosid.contact.AddressBookQueryaddressBookQuerythe address book query
Returnosid.contact.AddressBookListthe returned AddressBookList
ErrorsNULL_ARGUMENT addressBookQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED addressBookQuery is not of this service
CompliancemandatoryThis method must be implemented.