OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.TermForm
Implementsosid.OsidObjectForm
osid.OsidFederateableForm
Description

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

MethodgetDisplayLabelMetadata
Description

Gets the metadata for a display label title.

Returnosid.Metadatametadata for the display label
CompliancemandatoryThis method must be implemented.
MethodsetDisplayLabel
Description

Sets the display label.

ParametersstringdisplayLabelthe new display label
ErrorsINVALID_ARGUMENT displayLabel is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT displayLabel is null
CompliancemandatoryThis method must be implemented.
MethodclearDisplayLabel
Description

Removes the display label.

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

Gets the metadata for an open date.

Returnosid.Metadatametadata for the open date
CompliancemandatoryThis method must be implemented.
MethodsetOpenDate
Description

Sets the open date.

Parametersosid.calendaring.DateTimedatethe new open date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS date cannot be modified
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearOpenDate
Description

Clears the open date.

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

Gets the metadata for the registration start date.

Returnosid.Metadatametadata for the registration start date
CompliancemandatoryThis method must be implemented.
MethodsetRegistrationStart
Description

Sets the registration start date.

Parametersosid.calendaring.DateTimedatethe new registration start date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS date cannot be modified
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearRegistrationStart
Description

Clears the registration start date.

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

Gets the metadata for the registration end date.

Returnosid.Metadatametadata for the registration end date
CompliancemandatoryThis method must be implemented.
MethodsetRegistrationEnd
Description

Sets the registration end date.

Parametersosid.calendaring.DateTimedatethe new registration end date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS date cannot be modified
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearRegistrationEnd
Description

Clears the registration end date.

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

Gets the metadata for the classes start date.

Returnosid.Metadatametadata for the classes start date
CompliancemandatoryThis method must be implemented.
MethodsetClassesStart
Description

Sets the classes start date.

Parametersosid.calendaring.DateTimedatethe new classes start date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS date cannot be modified
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearClassesStart
Description

Clears the classes start date.

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

Gets the metadata for the classes end date.

Returnosid.Metadatametadata for the classes end date
CompliancemandatoryThis method must be implemented.
MethodsetClassesEnd
Description

Sets the classes end date.

Parametersosid.calendaring.DateTimedatethe new classes end date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS date cannot be modified
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearClassesEnd
Description

Clears the classes end date.

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

Gets the metadata for the add date.

Returnosid.Metadatametadata for the add date
CompliancemandatoryThis method must be implemented.
MethodsetAddDate
Description

Sets the add date.

Parametersosid.calendaring.DateTimedatethe new add date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS date cannot be modified
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearAddDate
Description

Clears the add date.

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

Gets the metadata for the drop date.

Returnosid.Metadatametadata for the drop date
CompliancemandatoryThis method must be implemented.
MethodsetDropDate
Description

Sets the drop date.

Parametersosid.calendaring.DateTimedatethe new drop date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS date cannot be modified
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearDropDate
Description

Clears the drop date.

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

Gets the metadata for the classes start date.

Returnosid.Metadatametadata for the classes start date
CompliancemandatoryThis method must be implemented.
MethodsetFinalExamStart
Description

Sets the final exam start date.

Parametersosid.calendaring.DateTimedatethe new final exam start date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS date cannot be modified
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearFinalExamStart
Description

Clears the final exam start date.

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

Gets the metadata for the final exam end date.

Returnosid.Metadatametadata for the final exam end date
CompliancemandatoryThis method must be implemented.
MethodsetFinalExamEnd
Description

Sets the final exam end date.

Parametersosid.calendaring.DateTimedatethe new final exam end date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS date cannot be modified
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearFinalExamEnd
Description

Clears the final exam end date.

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

Gets the metadata for the close date.

Returnosid.Metadatametadata for the close date
CompliancemandatoryThis method must be implemented.
MethodsetCloseDate
Description

Sets the close date.

Parametersosid.calendaring.DateTimedatethe new close date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS date cannot be modified
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearCloseDate
Description

Clears the close date.

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

Gets the TermFormRecord corresponding to the given term record Type.

Parametersosid.type.TypetermRecordTypea term record type
Returnosid.course.records.TermFormRecordthe term form record
ErrorsNULL_ARGUMENT termRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(termRecordType) is false
CompliancemandatoryThis method must be implemented.