Interface | osid.resource.GroupHierarchySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides a hierarchical view of resource
groups. Each node in the hierarchy is a unique 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 | getBinId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Bin Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBin | ||
Description |
Gets the | ||
Return | osid.resource.Bin | the Bin associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canAccessGroupHierarchy | ||
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 | useComparativeResourceView | ||
Description |
The returns from the group 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 | usePlenaryResourceView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedBinView | ||
Description |
Federates the view for methods in this session. A federated view will include resources in bins which are children of this bin in the bin hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedBinView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this bin only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | isMemberOfGroup | ||
Description |
Tests if a resource | ||
Parameters | osid.id.Id | groupId | a resource group Id |
osid.id.Id | resourceId | the Id of a resource | |
Return | boolean | true if this resourceId is a member of
groupId, f alse otherwise | |
Errors | NOT_FOUND | groupId is not found | |
NULL_ARGUMENT | groupId or resourceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getResourceNodeIds | ||
Description |
Gets a portion of the hierarchy for the given resource group. | ||
Parameters | osid.id.Id | resourceId | 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 resource node | |
Errors | NOT_FOUND | resourceId is not found | |
NULL_ARGUMENT | resourceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getResourceNodes | ||
Description |
Gets a portion of the hierarchy for the given resource group. | ||
Parameters | osid.id.Id | resourceId | 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.acknowledgement.BillingNode | a resource node | |
Errors | NOT_FOUND | resourceId is not found | |
NULL_ARGUMENT | resourceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |