OSID Logo
OSID Specifications
filing allocation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.filing.allocation.Allocation
Implementsosid.Extensible
osid.Browsable
Description

Allocation represents allocated resources in a file system.

MethodgetDirectoryPath
Description

Gets the absolute path to the directory responsible for these usage stats. The return may be a partition or volume containing the requested directory.

Returnstringpath name
CompliancemandatoryThis method must be implemented.
MethodgetDirectory
Description

Gets the directory responsible for these usage stats. The return may be a partition, quota controlled directory, or volume containing the requested directory.

Returnosid.filing.Directorydirectory
CompliancemandatoryThis method must be implemented.
MethodisAssignedToUser
Description

Tests if this allocation is assigned to a specific user.

Returnboolean true if this allocation is assigned to a specific user, false if this allocation applied to all users
CompliancemandatoryThis method must be implemented.
MethodgetAgentId
Description

Gets the agent Id of the user.

Returnosid.id.Idthe agent Id
ErrorsILLEGAL_STATE isAssignedToUser() is false
CompliancemandatoryThis method must be implemented.
MethodgetAgent
Description

Gets the agent of the user.

Returnosid.authentication.Agentthe agent
ErrorsILLEGAL_STATE isAssignedToUser() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetTotalSpace
Description

Gets the total space in bytes of this allocation.

Returncardinalnumber of bytes in this allocation
CompliancemandatoryThis method must be implemented.
MethodgetUsedSpace
Description

Gets the used space in bytes of this allocation.

Returncardinalnumber of used bytes in this allocation
CompliancemandatoryThis method must be implemented.
MethodgetAvailableSpace
Description

Gets the available space in bytes of this allocation.

Returncardinalnumber of available bytes in this allocation
CompliancemandatoryThis method must be implemented.
MethodgetTotalFiles
Description

Gets the total number of files of this allocation.

Returncardinalnumber of files in this allocation
CompliancemandatoryThis method must be implemented.
MethodgetUsedFiles
Description

Gets the used number of files of this allocation.

Returncardinalnumber of used files in this allocation
CompliancemandatoryThis method must be implemented.
MethodgetAvailableFiles
Description

Gets the available number o files of this allocation.

Returncardinalnumber of available files in this allocation
CompliancemandatoryThis method must be implemented.
MethodgetAllocationRecord
Description

Gets the allocation record corresponding to the given Allocation record Type. This method is used to retrieve an object implementing the requested record. The allocationRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(allocationRecordType) is true .

Parametersosid.type.TypeallocationRecordTypethe allocation record type
Returnosid.filing.allocation.records.AllocationRecordthe allocation record
ErrorsNULL_ARGUMENT allocationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(allocationRecordType) is false
CompliancemandatoryThis method must be implemented.