OSID Logo
OSID Specifications
filing allocation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.filing.allocation.AllocationLookupSession
Implementsosid.filing.allocation.AllocationSession
Description

This session defines methods for accessing space allocation and quotas.

MethodgetUserAllocationsForUser
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.

Parametersosid.id.IdagentIdthe agent Id of the user
Returnosid.filing.allocation.AllocationListthe allocation
ErrorsNULL_ARGUMENT agentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetUserAllocations
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.

Returnosid.filing.allocation.AllocationListthe allocation
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetUserAllocationsByUtilization
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.

Parameterscardinalpercentagethe utilization percentage (0-100)
Returnosid.filing.allocation.AllocationListthe allocation
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.