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

This session manages queries and sequencing to create "smart" dynamic address books. A ContactEnablerQuery can be retrieved from this session and mapped to this AddressBook to create a virtual collection of contact enablers. The contact enablers may be sequenced using the ContactEnablerSearchOrder from this session.

This AddressBook has a default query that matches any contact enabler and a default search order that specifies no sequencing. The queries may be examined using a ContactEnablerQueryInspector. The query may be modified by converting the inspector back to a ContactEnablerQuery.

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 address book
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.
MethodgetContactEnablerQuery
Description

Gets a contact enabler query.

Returnosid.contact.rules.ContactEnablerQuerythe contact enabler query
CompliancemandatoryThis method must be implemented.
MethodgetContactEnablerSearchOrder
Description

Gets a contact enabler search order.

Returnosid.contact.rules.ContactEnablerSearchOrderthe contact enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyContactEnablerQuery
Description

Applies a contact enabler query to this address book.

Parametersosid.contact.rules.ContactEnablerQuerycontactEnablerQuerythe contact enabler query
ErrorsNULL_ARGUMENT contactEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED contactEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectContactEnablerQuery
Description

Gets a contact enabler query inspector for this address book.

Returnosid.contact.rules.ContactEnablerQueryInspectorthe contact enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyContactEnablerSequencing
Description

Applies a contact enabler search order to this address book.

Parametersosid.contact.rules.ContactEnablerSearchOrdercontactEnablerSearchOrderthe contact enabler search order
ErrorsNULL_ARGUMENT contactEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED contactEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetContactEnablerQueryFromInspector
Description

Gets a contact enabler query from an inspector.

Parametersosid.contact.rules.ContactEnablerQueryInspectorcontactEnablerQueryInspectora contact enabler query inspector
Returnosid.contact.rules.ContactEnablerQuerythe contact enabler query
ErrorsNULL_ARGUMENT contactEnablerQueryInspector is null
UNSUPPORTED contactEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.