OSID Logo
OSID Specifications
filing allocation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.filing.allocation.FilingAllocationManager
Implementsosid.OsidManager
osid.filing.allocation.FilingAllocationProfile
Description

The filing allocation manager provides access sessions to retrieve and manage allocations. The sessions included in this manager are:

  • AllocationSession: a session for accessing usage information and quotas for the current user
  • AllocationLookupSession: a session for accessing usage information and quotas
  • AllocationAdminSession a session for assigning quotas
  • AllocationNotificationSession: a session for subscribing to usage warnings and quota changes
MethodgetAllocationSession
Description

Gets the session for accessing usage and quotas.

Returnosid.filing.allocation.AllocationSessionan AllocationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAllocation() is false
ComplianceoptionalThis method must be implemented if supportsAllocation() is true.
MethodgetAllocationSessionForDirectory
Description

Gets the session for accessing usage and quotas for a given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.

ParametersstringdirectoryPaththe pathname to the directory
Returnosid.filing.allocation.AllocationSessionan AllocationSession
ErrorsINVALID_ARGUMENT directoryPath is not a directory or an alias to a directory
NOT_FOUND directoryPath is not found
NULL_ARGUMENT directoryPath is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAllocation() is false
ComplianceoptionalThis method must be implemented if supportsAllocation() and supportsVisibleFederation() are true.
MethodgetAllocationLookupSession
Description

Gets the session for accessing usage and quotas.

Returnosid.filing.allocation.AllocationLookupSessionan AllocationLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAllocationLookup() is false
ComplianceoptionalThis method must be implemented if supportsAllocationLookup() is true.
MethodgetAllocationLookupSessionForDirectory
Description

Gets the session for accessing usage and quotas for a given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.

ParametersstringdirectoryPaththe pathname to the directory
Returnosid.filing.allocation.AllocationLookupSessionan AllocationLookupSession
ErrorsINVALID_ARGUMENT directoryPath is not a directory or an alias to a directory
NOT_FOUND directoryPath is not found
NULL_ARGUMENT directoryPath is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAllocationLookup() is false
ComplianceoptionalThis method must be implemented if supportsAllocationLookup() and supportsVisibleFederation() are true.
MethodgetAllocationAdminSession
Description

Gets the session for assigning quotas.

Returnosid.filing.allocation.AllocationAdminSessionan AllocationAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAllocationAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAllocationAdmin() is true.
MethodgetAllocationAdminSessionForDirectory
Description

Gets the session for assigning quotas for the given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.

ParametersstringdirectoryPaththe pathname to the directory
Returnosid.filing.allocation.AllocationAdminSessionan AllocationAdminSession
ErrorsINVALID_ARGUMENT directoryPath is not a directory or an alias to a directory
NOT_FOUND directoryPath is not found
NULL_ARGUMENT directoryPath is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAllocationAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAllocationAdmin() and supportsVisibleFederation() are true.
MethodgetAllocationNotificationSession
Description

Gets the session for receiving messages about changes to directories.

Parametersosid.filing.allocation.AllocationReceiverallocationReceiverthe notification callback
Returnosid.filing.allocation.AllocationNotificationSessionan AllocationNotificationSession
ErrorsNULL_ARGUMENT allocationReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAllocationNotification() is false
ComplianceoptionalThis method must be implemented if supportsDirectoryNotification() is true.
MethodgetAllocationNotificationSessionForDirectory
Description

Gets the session for receiving messages about usage warnings and quota changes for the given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.

Parametersosid.filing.allocation.AllocationReceiverallocationReceiverthe notification callback
stringdirectoryPaththe pathname to the directory
Returnosid.filing.allocation.AllocationNotificationSessionan AllocationNotificationSession
ErrorsINVALID_ARGUMENT directoryPath is not a directory or an alias to a directory
NOT_FOUND directoryPath is not found
NULL_ARGUMENT allocationReceiver or directoryPath is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAllocationNotification() is false
ComplianceoptionalThis method must be implemented if supportsAllocationNotification() and supportsVisibleFederation() are true.