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

Interface	osid.filing.allocation.AllocationForm
Implements	`osid.OsidExtensibleForm`
Implements	`osid.OsidBrowsableForm`
Used By	`osid.filing.allocation.AllocationAdminSession`
Description	`DirectoryEntryForm` defines methods in common to both `FileForm` and `DirectoryForm`.
Method	getTotalSpaceMetadata
Description	Gets the metadata for the total space.
Return	`osid.Metadata`		metadata for the total space
Compliance	`mandatory`		This method must be implemented.
Method	setTotalSpace
Description	Sets the total space.
Parameters	`cardinal`	`bytes`	the new total space
Errors	INVALID_ARGUMENT		`bytes` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearTotalSpace
Description	Clears the total space.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTotalFilesMetadata
Description	Gets the metadata for the total files.
Return	`osid.Metadata`		metadata for the total files
Compliance	`mandatory`		This method must be implemented.
Method	setTotalFiles
Description	Sets the total files.
Parameters	`cardinal`	`number`	the new total files
Errors	INVALID_ARGUMENT		`number` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearTotalFiles
Description	Clears the total files.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAllocationFormRecord
Description	Gets the `AllocationFormRecord` corresponding to the given allocation record `Type`.
Parameters	`osid.type.Type`	`allocationRecordType`	the allocation record type
Return	`osid.filing.allocation.records.AllocationFormRecord`		the allocation form 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.