OSID Logo
OSID Specifications
dictionary package
Version 3.0.0
Release Candidate Preview
Interfaceosid.dictionary.EntryForm
Implementsosid.OsidObjectForm
Description

This is the form for creating and updating an Entry. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the EntryAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetValueMetadata
Description

Gets the metadata for the vakue.

Returnosid.Metadatametadata for the value
CompliancemandatoryThis method must be implemented.
MethodsetValue
Description

Sets the value.

Parametersobjectvaluethe value
ErrorsINVALID_ARGUMENT value is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT value is null
CompliancemandatoryThis method must be implemented.
MethodclearValue
Description

Removes the value.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetEntryFormRecord
Description

Gets the EntryFormRecord corresponding to the given entry record Type.

Parametersosid.type.TypeentryRecordTypean entry record type
Returnosid.dictionary.records.EntryFormRecordthe entry form record
ErrorsNULL_ARGUMENT entryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(entryRecordType) is false
CompliancemandatoryThis method must be implemented.