OSID - osid.filing.allocation.Allocation Service Interface Definition

Interface	osid.filing.allocation.Allocation
Implements	`osid.Extensible`
Implements	`osid.Browsable`
Used By	`osid.filing.allocation.AllocationAdminSession`
	`osid.filing.allocation.AllocationList`
	`osid.filing.allocation.AllocationSession`
Description	`Allocation` represents allocated resources in a file system.
Method	getDirectoryPath
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.
Return	`string`		path name
Compliance	`mandatory`		This method must be implemented.
Method	getDirectory
Description	Gets the directory responsible for these usage stats. The return may be a partition, quota controlled directory, or volume containing the requested directory.
Return	`osid.filing.Directory`		directory
Compliance	`mandatory`		This method must be implemented.
Method	isAssignedToUser
Description	Tests if this allocation is assigned to a specific user.
Return	`boolean`		`true` if this allocation is assigned to a specific user, `false` if this allocation applied to all users
Compliance	`mandatory`		This method must be implemented.
Method	getAgentId
Description	Gets the agent `Id` of the user.
Return	`osid.id.Id`		the agent `Id`
Errors	ILLEGAL_STATE		`isAssignedToUser()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getAgent
Description	Gets the agent of the user.
Return	`osid.authentication.Agent`		the agent
Errors	ILLEGAL_STATE		`isAssignedToUser()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getTotalSpace
Description	Gets the total space in bytes of this allocation.
Return	`cardinal`		number of bytes in this allocation
Compliance	`mandatory`		This method must be implemented.
Method	getUsedSpace
Description	Gets the used space in bytes of this allocation.
Return	`cardinal`		number of used bytes in this allocation
Compliance	`mandatory`		This method must be implemented.
Method	getAvailableSpace
Description	Gets the available space in bytes of this allocation.
Return	`cardinal`		number of available bytes in this allocation
Compliance	`mandatory`		This method must be implemented.
Method	getTotalFiles
Description	Gets the total number of files of this allocation.
Return	`cardinal`		number of files in this allocation
Compliance	`mandatory`		This method must be implemented.
Method	getUsedFiles
Description	Gets the used number of files of this allocation.
Return	`cardinal`		number of used files in this allocation
Compliance	`mandatory`		This method must be implemented.
Method	getAvailableFiles
Description	Gets the available number o files of this allocation.
Return	`cardinal`		number of available files in this allocation
Compliance	`mandatory`		This method must be implemented.
Method	getAllocationRecord
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`.
Parameters	`osid.type.Type`	`allocationRecordType`	the allocation record type
Return	`osid.filing.allocation.records.AllocationRecord`		the allocation record
Errors	NULL_ARGUMENT		`allocationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(allocationRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.