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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Method Details

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.