Interface | osid.filing.allocation.AllocationLookupSession | ||
---|---|---|---|
Implements | osid.filing.allocation.AllocationSession | ||
Description |
This session defines methods for accessing space allocation and quotas. | ||
Method | getUserAllocationsForUser | ||
Description |
Gets the user quota allocations of the data store for the given user including any subdirectories. The directory available by the allocation may indicate a higher level directory than the one requested if the one requested is a sub-directory inside the qoutad data store. | ||
Parameters | osid.id.Id | agentId | the agent Id of the user |
Return | osid.filing.allocation.AllocationList | the allocation | |
Errors | NULL_ARGUMENT | agentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getUserAllocations | ||
Description |
Gets the user quota allocation of the data store for each user. The directory available by the allocation may indicate a higher level directory than the one requested if the one requested is a sub-directory inside the qoutad data store. | ||
Return | osid.filing.allocation.AllocationList | the allocation | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getUserAllocationsByUtilization | ||
Description |
Gets the quota allocations of the data store for all users matching or exceeding the given utilization. The directory available by the allocation may indicate a higher level directory than the one requested if the one requested is a sub-directory inside the qoutad data store. | ||
Parameters | cardinal | percentage | the utilization percentage (0-100) |
Return | osid.filing.allocation.AllocationList | the allocation | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |