Interface | osid.cataloging.CatalogHierarchyDesignSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages a hierarchy of catalogs. | ||
Method | getCatalogHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogHierarchy | ||
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 | assessment failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canModifyCatalogHierarchy | ||
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 | addRootCatalog | ||
Description |
Adds a root catalog. | ||
Parameters | osid.id.Id | catalogId | the Id of a catalog |
Errors | ALREADY_EXISTS | catalogId is already in hierarchy | |
NOT_FOUND | catalogId not found | ||
NULL_ARGUMENT | catalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeRootCatalog | ||
Description |
Removes a root catalog. | ||
Parameters | osid.id.Id | catalogId | the Id of a catalog |
Errors | NOT_FOUND | catalogId is not a root | |
NULL_ARGUMENT | catalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | addChildCatalog | ||
Description |
Adds a child to a catalog. | ||
Parameters | osid.id.Id | catalogId | the Id of a catalog |
osid.id.Id | childId | the Id of the new child | |
Errors | ALREADY_EXISTS | catalogId is already a parent of childId | |
NOT_FOUND | catalogId or childId not found | ||
NULL_ARGUMENT | catalogId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildCatalog | ||
Description |
Removes a child from a catalog. | ||
Parameters | osid.id.Id | catalogId | the Id of a catalog |
osid.id.Id | childId | the Id of the new child | |
Errors | NOT_FOUND | catalogId is not a parent of childId | |
NULL_ARGUMENT | catalogId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildCatalogs | ||
Description |
Removes all children from a catalog. | ||
Parameters | osid.id.Id | catalogId | the Id of a catalog |
Errors | NOT_FOUND | catalogId is not in hierarchy | |
NULL_ARGUMENT | catalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. |