org.osid.personnel

Interface RealmForm

All Superinterfaces:

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

All Known Subinterfaces:

RealmBatchForm

public interface RealmForm
extends OsidCatalogForm

This is the form for creating and updating Realms. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RealmAdminSession. 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
RealmFormRecord	getRealmFormRecord(Type realmRecordType) Gets the RealmFormRecord interface corresponding to the given realm 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

getRealmFormRecord

RealmFormRecord getRealmFormRecord(Type realmRecordType)
                                   throws OperationFailedException

Gets the RealmFormRecord interface corresponding to the given realm record Type.

Parameters:

realmRecordType - the realm record type

Returns:

the record

Throws:

NullArgumentException - realmRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(realmRecordType) is false

Compliance:

mandatory - This method must be implemented.