OSID Logo
OSID Specifications
configuration package
Version 3.1.0
Interfaceosid.configuration.ConfigurationForm
Implementsosid.OsidCatalogForm
Implemented Byosid.configuration.batch.ConfigurationBatchForm
Used Byosid.configuration.ConfigurationAdminSession
Description

This is the form for creating and updating configurations. 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.

MethodgetRegistryMetadata
Description

Gets the metadata for the registry flag.

Returnosid.Metadata metadata for the registry
Compliancemandatory This method must be implemented.
MethodsetRegistry
Description

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

Parametersbooleanregistry true if the parameters in this configuration cannot contain values, false otherwise
ErrorsINVALID_ARGUMENT registry is invalid
NO_ACCESS registry cannot be modified
Compliancemandatory This method must be implemented.
MethodgetConfigurationFormRecord
Description

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

Parametersosid.type.TypeconfigurationRecordType a configuration record type
Returnosid.configuration.records.ConfigurationFormRecord the configuration form record
ErrorsNULL_ARGUMENT configurationRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(configurationRecordType) is false
Compliancemandatory This method must be implemented.