public interface AllocationForm extends OsidExtensibleForm, OsidBrowsableForm
DirectoryEntryForm
defines methods in common to both
FileForm
and DirectoryForm.
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.
|
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getTotalSpaceMetadata()
mandatory
- This method must be implemented. void setTotalSpace(long bytes)
bytes
- the new total spaceInvalidArgumentException
- bytes
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearTotalSpace()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getTotalFilesMetadata()
mandatory
- This method must be implemented. void setTotalFiles(long number)
number
- the new total filesInvalidArgumentException
- number
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearTotalFiles()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. AllocationFormRecord getAllocationFormRecord(Type allocationRecordType) throws OperationFailedException
AllocationFormRecord
corresponding to the
given allocation record Type.
allocationRecordType
- the allocation record typeNullArgumentException
- allocationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(allocationRecordType)
is false
mandatory
- This method must be implemented.