OSID Logo
OSID Specifications
ontology package
Version 3.1.0
Interfaceosid.ontology.SubjectForm
Implementsosid.OsidObjectForm
osid.OsidFederateableForm
Implemented Byosid.ontology.batch.SubjectBatchForm
Used Byosid.ontology.SubjectAdminSession
Description

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

MethodgetCodeMetadata
Description

Gets the metadata for the code.

Returnosid.Metadata metadata for the code
Compliancemandatory This method must be implemented.
MethodsetCode
Description

Sets the code.

Parametersstringcode the new code
ErrorsINVALID_ARGUMENT code is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT code is null
Compliancemandatory This method must be implemented.
MethodclearCode
Description

Clears the code.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
Compliancemandatory This method must be implemented.
MethodgetSubjectFormRecord
Description

Gets the SubjectFormRecord corresponding to the given subject record Type.

Parametersosid.type.TypesubjectRecordType the subject record type
Returnosid.ontology.records.SubjectFormRecord the subject form record
ErrorsNULL_ARGUMENT subjectRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(subjectRecordType) is false
Compliancemandatory This method must be implemented.