org.osid.search

Interface EngineForm

All Superinterfaces:

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

public interface EngineForm
extends OsidCatalogForm

This is the form for creating and updating Engines. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the EngineAdminSession. 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
EngineFormRecord	getEngineFormRecord(Type engineRecordType) Gets the EngineFormRecord corresponding to the given engine 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

getEngineFormRecord

EngineFormRecord getEngineFormRecord(Type engineRecordType)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets the EngineFormRecord corresponding to the given engine record Type.

Parameters:

engineRecordType - the engine record type

Returns:

the record

Throws:

NullArgumentException - engineRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(engineRecordType) is false

Compliance:

mandatory - This method must be implemented.