org.osid.configuration

Interface ConfigurationForm

All Superinterfaces:

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

All Known Subinterfaces:

ConfigurationBatchForm

public interface ConfigurationForm
extends OsidCatalogForm

This is the form for creating and updating configuration objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ConfigurationAdminSession. 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
ConfigurationFormRecord	getConfigurationFormRecord(Type configurationRecordType) Gets the ConfigurationFormRecord corresponding to the given configuration record interface Type.
Metadata	getRegistryMetadata() Gets the metadata for the registry flag.
void	setRegistry(boolean registry) Sets the registry flag that indicates if the parameters mapped to this configuration contain no values.

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

getRegistryMetadata

Metadata getRegistryMetadata()

Gets the metadata for the registry flag.

Returns:

metadata for the registry

Compliance:

mandatory - This method must be implemented.

setRegistry

void setRegistry(boolean registry)

Sets the registry flag that indicates if the parameters mapped to this configuration contain no values.

Parameters:

registry - true if the parameters in this configuration cannot contain values, false otherwise

Throws:

InvalidArgumentException - registry is invalid

NoAccessException - registry cannot be modified

Compliance:

mandatory - This method must be implemented.

getConfigurationFormRecord

ConfigurationFormRecord getConfigurationFormRecord(Type configurationRecordType)
                                                   throws OperationFailedException

Gets the ConfigurationFormRecord corresponding to the given configuration record interface Type.

Parameters:

configurationRecordType - a configuration record type

Returns:

the configuration form record

Throws:

NullArgumentException - configurationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(configurationRecordType) is false

Compliance:

mandatory - This method must be implemented.