org.osid.hold

Interface OublietteForm

All Superinterfaces:

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

All Known Subinterfaces:

OublietteBatchForm

public interface OublietteForm
extends OsidCatalogForm

This is the form for creating and updating oubliettes. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the OublietteAdminSession. 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
OublietteFormRecord	getOublietteFormRecord(Type oublietteRecordType) Gets the OublietteFormRecord corresponding to the given oubliette record Type.

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

Methods inherited from interface org.osid.OsidSourceableForm

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

Method Detail

getOublietteFormRecord

OublietteFormRecord getOublietteFormRecord(Type oublietteRecordType)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Gets the OublietteFormRecord corresponding to the given oubliette record Type.

Parameters:

oublietteRecordType - an oubliette record type

Returns:

the oubliette form record

Throws:

NullArgumentException - oublietteRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(oublietteRecordType) is false

Compliance:

mandatory - This method must be implemented.