| Interface | osid.course.Term | ||
|---|---|---|---|
| Implements | osid.OsidObject | ||
osid.Federateable | |||
| Description |
A | ||
| Method | getDisplayLabel | ||
| Description |
Gets a display label for this term which may be less formal than the display name. | ||
| Return | osid.locale.DisplayText | the term label | |
| Compliance | mandatory | This method must be implemented. | |
| Method | hasOpenDate | ||
| Description |
Tests if this term has an open date when published offerings are finalized. | ||
| Return | boolean | true if there is an open date associated with this term,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOpenDate | ||
| Description |
Gets the open date when published offerings are finalized. | ||
| Return | osid.calendaring.DateTime | the open date | |
| Errors | ILLEGAL_STATE | hasOpenDate() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | hasRegistrationPeriod | ||
| Description |
Tests if this term has a registration period. | ||
| Return | boolean | true if there is a registration period associated with this
term, false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRegistrationStart | ||
| Description |
Gets the start of the registration period. | ||
| Return | osid.calendaring.DateTime | the start date | |
| Errors | ILLEGAL_STATE | hasRegistrationPeriod() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRegistrationEnd | ||
| Description |
Gets the end of the registration period. | ||
| Return | osid.calendaring.DateTime | the end date | |
| Errors | ILLEGAL_STATE | hasRegistrationPeriod() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getClassesStart | ||
| Description |
Gets the start of classes. | ||
| Return | osid.calendaring.DateTime | the start date | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getClassesEnd | ||
| Description |
Gets the end of classes. | ||
| Return | osid.calendaring.DateTime | the end date | |
| Compliance | mandatory | This method must be implemented. | |
| Method | hasAddDropDate | ||
| Description |
Tests if this term has an add/drop date. | ||
| Return | boolean | true if there is an add/drop date associated with this term,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAddDate | ||
| Description |
Gets the add/drop date. | ||
| Return | osid.calendaring.DateTime | the add/drop date | |
| Errors | ILLEGAL_STATE | hasAddDropDate() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDropDate | ||
| Description |
Gets the add/drop date. | ||
| Return | osid.calendaring.DateTime | the add/drop date | |
| Errors | ILLEGAL_STATE | hasAddDropDate() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | hasFinalExamPeriod | ||
| Description |
Tests if this term has a final eam period. | ||
| Return | boolean | true if there is a final exam period associated with this
term, false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFinalExamStart | ||
| Description |
Gets the start of the final exam period. | ||
| Return | osid.calendaring.DateTime | the start date | |
| Errors | ILLEGAL_STATE | hasFinalExamPeriod() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFinalExamEnd | ||
| Description |
Gets the end of the final exam period. | ||
| Return | osid.calendaring.DateTime | the end date | |
| Errors | ILLEGAL_STATE | hasFinalExamPeriod() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | hasCloseDate | ||
| Description |
Tests if this term has a close date when results from course offerings are finalized. | ||
| Return | boolean | true if there is a close date associated with this term,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCloseDate | ||
| Description |
Gets the close date when results of course offerings are finalized. | ||
| Return | osid.calendaring.DateTime | the close date | |
| Errors | ILLEGAL_STATE | hasCloseDate() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTermRecord | ||
| Description |
Gets the term record corresponding to the given | ||
| Parameters | osid.type.Type | termRecordType | the type of term record to retrieve |
| Return | osid.course.records.TermRecord | the term record | |
| Errors | NULL_ARGUMENT | termRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(termRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |