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

This session provides methods to retrieve ContactEnabler to AddressBook mappings. A ContactEnabler may appear in multiple AddressBook objects. Each address book may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupContactEnablerAddressBookMappings
Description

Tests if this user can perform lookups of contact enabler/address book mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeContactEnablerAddressBookView
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.
MethodusePlenaryContactEnablerAddressBookView
Description

A complete view of the ContactEnabler and 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.
MethodgetContactEnablerIdsByAddressBook
Description

Gets the list of ContactEnablerIds associated with an AddressBook.

Parametersosid.id.IdaddressBookId Id of the AddressBook
Returnosid.id.IdListlist of related contact enabler Ids
ErrorsNOT_FOUND addressBookId is not found
NULL_ARGUMENT addressBookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetContactEnablersByAddressBook
Description

Gets the list of contact enablers associated with an AddressBook.

Parametersosid.id.IdaddressBookId Id of the AddressBook
Returnosid.contact.rules.ContactEnablerListlist of related contact enablers
ErrorsNOT_FOUND addressBookId is not found
NULL_ARGUMENT addressBookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetContactEnablerIdsByAddressBooks
Description

Gets the list of ContactEnabler Ids corresponding to a list of AddressBooks.

Parametersosid.id.IdListaddressBookIdslist of address book Ids
Returnosid.id.IdListlist of contact enabler Ids
ErrorsNULL_ARGUMENT addressBookIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetContactEnablersByAddressBooks
Description

Gets the list of contact enablers corresponding to a list of AddressBooks.

Parametersosid.id.IdListaddressBookIdslist of address book Ids
Returnosid.contact.rules.ContactEnablerListlist of contact enablers
ErrorsNULL_ARGUMENT addressBookIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAddressBookIdsByContactEnabler
Description

Gets the AddressBook Ids mapped to a ContactEnabler.

Parametersosid.id.IdcontactEnablerId Id of a ContactEnabler
Returnosid.id.IdListlist of address books
ErrorsNOT_FOUND contactEnablerId is not found
NULL_ARGUMENT contactEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAddressBooksByContactEnabler
Description

Gets the AddressBooks mapped to a ContactEnabler.

Parametersosid.id.IdcontactEnablerId Id of a ContactEnabler
Returnosid.contact.AddressBookListlist of address books
ErrorsNOT_FOUND contactEnablerId is not found
NULL_ARGUMENT contactEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.