Interface | osid.contact.AddressBookHierarchyDesignSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages a hierarchy of address books.
AddressBooks may be organized into a hierarchy for organizing
or federating. A parent | ||
Method | getAddressBookHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBookHierarchy | ||
Description |
Gets the hierarchy associated with this session. | ||
Return | osid.hierarchy.Hierarchy | the hierarchy associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canModifyAddressBookHierarchy | ||
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 | ||
Return | boolean | false if changing this hierarchy is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | addRootAddressBook | ||
Description |
Adds a root address book. | ||
Parameters | osid.id.Id | addressBookId | the Id of an address book |
Errors | ALREADY_EXISTS | addressBookId is already in hierarchy | |
NOT_FOUND | addressBookId is not found | ||
NULL_ARGUMENT | addressBookId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeRootAddressBook | ||
Description |
Removes a root address book. | ||
Parameters | osid.id.Id | addressBookId | the Id of an address book |
Errors | NOT_FOUND | addressBookId is not a root | |
NULL_ARGUMENT | addressBookId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addChildAddressBook | ||
Description |
Adds a child to an address book. | ||
Parameters | osid.id.Id | addressBookId | the Id of an address book |
osid.id.Id | childId | the Id of the new child | |
Errors | ALREADY_EXISTS | addressBookId is already a parent of childId | |
NOT_FOUND | addressBookId or childId not found | ||
NULL_ARGUMENT | addressBookId or childId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildAddressBook | ||
Description |
Removes a child from an address book. | ||
Parameters | osid.id.Id | addressBookId | the Id of an address book |
osid.id.Id | childId | the Id of the new child | |
Errors | NOT_FOUND | addressBookId not a parent of childId | |
NULL_ARGUMENT | addressBookId or childId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildAddressBooks | ||
Description |
Removes all children from an address book. | ||
Parameters | osid.id.Id | addressBookId | the Id of an address book |
Errors | NOT_FOUND | addressBookId not found | |
NULL_ARGUMENT | addressBookId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |