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

This session provides methods for searching among ContactEnabler objects. The search query is constructed using the ContactEnablerQuery.

This session defines views that offer differing behaviors for searching.

  • federated address book view: searches include contact enablers in address books of which this address book is an ancestor in the address book hierarchy
  • isolated address book view: searches are restricted to contact enablers in this address book

Contact enablers may have a query record indicated by their respective record types. The query record is accessed via the 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.
MethodcanSearchContactEnablers
Description

Tests if this user can perform ContactEnabler 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 search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedAddressBookView
Description

Federates the view for methods in this session. A federated view will include contact enablers in address books which are children of this broker in the address book hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedAddressBookView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this address book only.

CompliancemandatoryThis method is must be implemented.
MethodgetContactEnablerQuery
Description

Gets a contact enabler query.

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

Gets a list of ContactEnablers matching the given contact enabler query.

Parametersosid.contact.rules.ContactEnablerQuerycontactEnablerQuerythe contact enabler query
Returnosid.contact.rules.ContactEnablerListthe returned ContactEnablerList
ErrorsNULL_ARGUMENT contactEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED contactEnablerQuery is not of this service
CompliancemandatoryThis method must be implemented.