org.osid.workflow

Interface OfficeForm

All Superinterfaces:

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

All Known Subinterfaces:

OfficeBatchForm

public interface OfficeForm
extends OsidCatalogForm

This is the form for creating and updating offices. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the OfficeAdminSession. 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
OfficeFormRecord	getOfficeFormRecord(Type officeRecordType) Gets the OfficeFormRecord corresponding to the given 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

getOfficeFormRecord

OfficeFormRecord getOfficeFormRecord(Type officeRecordType)
                                     throws OperationFailedException

Gets the OfficeFormRecord corresponding to the given office record Type.

Parameters:

officeRecordType - a office record type

Returns:

the office form record

Throws:

NullArgumentException - officeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(officeRecordType) is false

Compliance:

mandatory - This method must be implemented.