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

This session manages queries and sequencing to create "smart" dynamic catalogs. An AddressQuery can be retrieved from this session and mapped to this AddressBook to create a virtual collection of Addresses. The addresses may be sequenced using the AddressSearchOrder from this session.

This AddressBook has a default query that matches any address and a default search order that specifies no sequencing. The queries may be examined using an AddressQueryInspector. The query may be modified by converting the inspector back to an AddressQuery.

MethodgetAddressBookId
Description

Gets the AddressBook Id associated with this session.

Returnosid.id.Idthe AddressBook Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAddressBook
Description

Gets the AddressBook associated with this session.

Returnosid.contact.AddressBookthe AddressBook associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartAddressBooks
Description

Tests if this user can manage smart address books. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart address book management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAddressQuery
Description

Gets an address query.

Returnosid.contact.AddressQuerythe address query
CompliancemandatoryThis method must be implemented.
MethodgetAddressSearchOrder
Description

Gets an address search order.

Returnosid.contact.AddressSearchOrderthe address search order
CompliancemandatoryThis method must be implemented.
MethodapplyAddressQuery
Description

Applies an address query to this address book.

Parametersosid.contact.AddressQueryaddressQuerythe address query
ErrorsNULL_ARGUMENT addressQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED addressQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectAddressQuery
Description

Gets an address query inspector for this address book.

Returnosid.contact.AddressQueryInspectorthe address query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyAddressSequencing
Description

Applies an address search order to this address book.

Parametersosid.contact.AddressSearchOrderaddressSearchOrderthe address search order
ErrorsNULL_ARGUMENT addressSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED addressSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAddressQueryFromInspector
Description

Gets an address query from an inspector.

Parametersosid.contact.AddressQueryInspectoraddressQueryInspectora query inspector
Returnosid.contact.AddressQuerythe address query
ErrorsNULL_ARGUMENT addressQueryInspector is null
UNSUPPORTED addressQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.