org.osid.filing

Interface DirectoryForm

All Superinterfaces:

DirectoryEntryForm, Extensible, Identifiable, OsidBrowsableForm, OsidCatalogForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable

public interface DirectoryForm
extends OsidCatalogForm, DirectoryEntryForm

This is the form for creating and updating Directory objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the DirectoryAdminSession. 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
DirectoryFormRecord	getDirectoryFormRecord(Type directoryRecordType) Gets the DirectoryFormRecord corresponding to the given directory record Type.

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

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

getDirectoryFormRecord

DirectoryFormRecord getDirectoryFormRecord(Type directoryRecordType)
                                           throws OperationFailedException

Gets the DirectoryFormRecord corresponding to the given directory record Type.

Parameters:

directoryRecordType - the directory record type

Returns:

the directory form record

Throws:

NullArgumentException - directoryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(directoryRecordType) is false

Compliance:

mandatory - This method must be implemented.