org.osid.tracking

Interface FrontOfficeForm

All Superinterfaces:

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

All Known Subinterfaces:

FrontOfficeBatchForm

public interface FrontOfficeForm
extends OsidCatalogForm

This is the form for creating and updating frontOffices. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the FrontOfficeAdminSession. 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
FrontOfficeFormRecord	getFrontOfficeFormRecord(Type frontOfficeRecordType) Gets the FrontOfficeFormRecord corresponding to the given front office 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

getFrontOfficeFormRecord

FrontOfficeFormRecord getFrontOfficeFormRecord(Type frontOfficeRecordType)
                                               throws OperationFailedException

Gets the FrontOfficeFormRecord corresponding to the given front office record Type.

Parameters:

frontOfficeRecordType - a front office record type

Returns:

the front office form record

Throws:

NullArgumentException - frontOfficeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(frontOfficeRecordType) is false

Compliance:

mandatory - This method must be implemented.