org.osid.filing.allocation

Interface AllocationForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, Suppliable

public interface AllocationForm
extends OsidExtensibleForm, OsidBrowsableForm

DirectoryEntryForm defines methods in common to both FileForm and DirectoryForm.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearTotalFiles() Clears the total files.
void	clearTotalSpace() Clears the total space.
AllocationFormRecord	getAllocationFormRecord(Type allocationRecordType) Gets the AllocationFormRecord corresponding to the given allocation record Type.
Metadata	getTotalFilesMetadata() Gets the metadata for the total files.
Metadata	getTotalSpaceMetadata() Gets the metadata for the total space.
void	setTotalFiles(long number) Sets the total files.
void	setTotalSpace(long bytes) Sets the total space.

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

getTotalSpaceMetadata

Metadata getTotalSpaceMetadata()

Gets the metadata for the total space.

Returns:

metadata for the total space

Compliance:

mandatory - This method must be implemented.

setTotalSpace

void setTotalSpace(long bytes)

Sets the total space.

Parameters:

bytes - the new total space

Throws:

InvalidArgumentException - bytes is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearTotalSpace

void clearTotalSpace()

Clears the total space.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getTotalFilesMetadata

Metadata getTotalFilesMetadata()

Gets the metadata for the total files.

Returns:

metadata for the total files

Compliance:

mandatory - This method must be implemented.

setTotalFiles

void setTotalFiles(long number)

Sets the total files.

Parameters:

number - the new total files

Throws:

InvalidArgumentException - number is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearTotalFiles

void clearTotalFiles()

Clears the total files.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getAllocationFormRecord

AllocationFormRecord getAllocationFormRecord(Type allocationRecordType)
                                             throws OperationFailedException

Gets the AllocationFormRecord corresponding to the given allocation record Type.

Parameters:

allocationRecordType - the allocation record type

Returns:

the allocation form record

Throws:

NullArgumentException - allocationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(allocationRecordType) is false

Compliance:

mandatory - This method must be implemented.