org.osid.control

Interface SystemForm

All Superinterfaces:

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

All Known Subinterfaces:

SystemBatchForm

public interface SystemForm
extends OsidCatalogForm

This is the form for creating and updating systems. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the SystemAdminSession. 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
SystemFormRecord	getSystemFormRecord(Type systemRecordType) Gets the SystemFormRecord corresponding to the given system 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

getSystemFormRecord

SystemFormRecord getSystemFormRecord(Type systemRecordType)
                                     throws OperationFailedException

Gets the SystemFormRecord corresponding to the given system record Type.

Parameters:

systemRecordType - a system record type

Returns:

the system form record

Throws:

NullArgumentException - systemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(systemRecordType) is false

Compliance:

mandatory - This method must be implemented.