org.osid.filing

Interface FileForm

All Superinterfaces:

DirectoryEntryForm, Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable

public interface FileForm
extends DirectoryEntryForm

This is the form for creating and updating Files. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the FileAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and Description
FileFormRecord	getFileFormRecord(Type fileRecordType) Gets the FileFormRecord corresponding to the given file record Type.

Methods inherited from interface org.osid.filing.DirectoryEntryForm

clearOwner, getOwnerMetadata, setOwner

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

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

getFileFormRecord

FileFormRecord getFileFormRecord(Type fileRecordType)
                                 throws OperationFailedException

Gets the FileFormRecord corresponding to the given file record Type.

Parameters:

fileRecordType - the file record type

Returns:

the file form record

Throws:

NullArgumentException - fileRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(fileRecordType) is false

Compliance:

mandatory - This method must be implemented.