Interface | osid.configuration.ConfigurationHierarchySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for traversing a hierarchy of
A user may not be authorized to traverse the entire
hierarchy. Parts of the hierarchy may be made invisible
through omission from the returns of This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | getConfigurationHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the configuration Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getConfigurationHierarchy | ||
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 | canAccessConfigurationHierarchy | ||
Description |
Tests if this user can perform hierarchy queries. 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 | ||
Return | boolean | false if hierarchy traversal methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeConfigurationView | ||
Description |
The returns from the configuration 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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryConfigurationView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRootConfigurationIds | ||
Description |
Gets the root configuration | ||
Return | osid.id.IdList | the root configuration Ids | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRootConfigurations | ||
Description |
Gets the root configurations in the configuration
hierarchy. A node with no parents is an orphan. While all
configuration | ||
Return | osid.configuration.ConfigurationList | the root configurations | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | hasParentConfigurations | ||
Description |
Tests if the | ||
Parameters | osid.id.Id | configurationId | a configuration Id |
Return | boolean | true if the configuration has parents, f alse
otherwise | |
Errors | NOT_FOUND | configurationId is not found | |
NULL_ARGUMENT | configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isParentOfConfiguration | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | configurationId | a configuration Id | |
Return | boolean | true if this id is a parent of
configurationId, f alse otherwise | |
Errors | NOT_FOUND | configurationId is not found | |
NULL_ARGUMENT | id or configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getParentConfigurationIds | ||
Description |
Gets the parent | ||
Parameters | osid.id.Id | configurationId | a configuration Id |
Return | osid.id.IdList | the parent Ids of the configuration | |
Errors | NOT_FOUND | configurationId is not found | |
NULL_ARGUMENT | configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParentConfigurations | ||
Description |
Gets the parents of the given configuration. | ||
Parameters | osid.id.Id | configurationId | the Id to query |
Return | osid.configuration.ConfigurationList | the parents of the configuration | |
Errors | NOT_FOUND | configurationId not found | |
NULL_ARGUMENT | configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isAncestorOfConfiguration | ||
Description |
Tests if an Id is an ancestor of a configuration. | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | configurationId | the Id of a configuration | |
Return | boolean | tru e if this id is an ancestor of
configurationId, false otherwise | |
Errors | NOT_FOUND | configurationId is not found | |
NULL_ARGUMENT | id or configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | hasChildConfigurations | ||
Description |
Tests if a configuration has any children. | ||
Parameters | osid.id.Id | configurationId | a configurationId |
Return | boolean | true if the configurationId has children,
false otherwise | |
Errors | NOT_FOUND | configurationId not found | |
NULL_ARGUMENT | configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isChildOfConfiguration | ||
Description |
Tests if a node is a direct child of another. | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | configurationId | the Id of a configuration | |
Return | boolean | true if the id is a child of
configurationId, false otherwise | |
Errors | NOT_FOUND | configurationId not found | |
NULL_ARGUMENT | id or configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getChildConfigurationIds | ||
Description |
Gets the child | ||
Parameters | osid.id.Id | configurationId | the Id to query |
Return | osid.id.IdList | the children of the configuration | |
Errors | NOT_FOUND | configurationId is not found | |
NULL_ARGUMENT | configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChildConfigurations | ||
Description |
Gets the children of the given configuration. | ||
Parameters | osid.id.Id | configurationId | the Id to query |
Return | osid.configuration.ConfigurationList | the children of the configuration | |
Errors | NOT_FOUND | configurationId not found | |
NULL_ARGUMENT | configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isDescendantOfConfiguration | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | configurationId | the Id of a configuration | |
Return | boolean | true if the id is a descendant of the
configurationId, false otherwise | |
Errors | NOT_FOUND | configurationId is not found | |
NULL_ARGUMENT | id or configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getConfigurationNodeIds | ||
Description |
Gets a portion of the hierarchy for the given configuration. | ||
Parameters | osid.id.Id | configurationId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the node. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the node. | |
boolean | includeSiblings | true to include the siblings of the given node, false
to omit the siblings | |
Return | osid.hierarchy.Node | a configuration node | |
Errors | NOT_FOUND | configurationId not found | |
NULL_ARGUMENT | configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConfigurationNodes | ||
Description |
Gets a portion of the hierarchy for the given configuration. | ||
Parameters | osid.id.Id | configurationId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the node. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the node. | |
boolean | includeSiblings | true to include the siblings of the given node, false
to omit the siblings | |
Return | osid.configuration.ConfigurationNode | a configuration node | |
Errors | NOT_FOUND | configurationId not found | |
NULL_ARGUMENT | configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |