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

This session manages a hierarchy of address books. AddressBooks may be organized into a hierarchy for organizing or federating. A parent AddressBook includes all of the contacts of its children such that a single root node contains all of the contacts of the federation.

MethodgetAddressBookHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAddressBookHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanModifyAddressBookHierarchy
Description

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returnboolean false if changing this hierarchy is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddRootAddressBook
Description

Adds a root address book.

Parametersosid.id.IdaddressBookIdthe Id of an address book
ErrorsALREADY_EXISTS addressBookId is already in hierarchy
NOT_FOUND addressBookId is not found
NULL_ARGUMENT addressBookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootAddressBook
Description

Removes a root address book.

Parametersosid.id.IdaddressBookIdthe Id of an address book
ErrorsNOT_FOUND addressBookId is not a root
NULL_ARGUMENT addressBookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildAddressBook
Description

Adds a child to an address book.

Parametersosid.id.IdaddressBookIdthe Id of an address book
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS addressBookId is already a parent of childId
NOT_FOUND addressBookId or childId not found
NULL_ARGUMENT addressBookId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildAddressBook
Description

Removes a child from an address book.

Parametersosid.id.IdaddressBookIdthe Id of an address book
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND addressBookId not a parent of childId
NULL_ARGUMENT addressBookId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildAddressBooks
Description

Removes all children from an address book.

Parametersosid.id.IdaddressBookIdthe Id of an address book
ErrorsNOT_FOUND addressBookId not found
NULL_ARGUMENT addressBookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.