OSID Logo
OSID Specifications
process package
Version 3.0.0
Release Candidate Preview
Interfaceosid.process.StateForm
Implementsosid.OsidObjectForm
Description

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

MethodgetStateFormRecord
Description

Gets the StateFormRecord corresponding to the given State record Type.

Parametersosid.type.TypestateRecordTypethe state record type
Returnosid.process.records.StateFormRecordthe record
ErrorsNULL_ARGUMENT stateRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(stateRecordType) is false
CompliancemandatoryThis method must be implemented.