org.osid.course

Interface Term

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidObject

public interface Term
extends OsidObject, Federateable

A Term represents a period of time in which a course is offered. This Term contains information on severel milestones that may drive the behavior of schedules and registration. These periods of time may be linked to the Term in the Calendaring OSID to effect the behavior of the RecurringEvents.

Method Summary

Methods

Modifier and Type	Method and Description
DateTime	getAddDate() Gets the add/drop date.
DateTime	getClassesEnd() Gets the end of classes.
DateTime	getClassesStart() Gets the start of classes.
DateTime	getCloseDate() Gets the close date when results of course offerings are finalized.
DisplayText	getDisplayLabel() Gets a display label for this term which may be less formal than the display name.
DateTime	getDropDate() Gets the add/drop date.
DateTime	getFinalExamEnd() Gets the end of the final exam period.
DateTime	getFinalExamStart() Gets the start of the final exam period.
DateTime	getOpenDate() Gets the open date when published offerings are finalized.
DateTime	getRegistrationEnd() Gets the end of the registration period.
DateTime	getRegistrationStart() Gets the start of the registration period.
TermRecord	getTermRecord(Type termRecordType) Gets the term record corresponding to the given Term record Type.
boolean	hasAddDropDate() Tests if this term has an add/drop date.
boolean	hasCloseDate() Tests if this term has a close date when results from course offerings are finalized.
boolean	hasFinalExamPeriod() Tests if this term has a final eam period.
boolean	hasOpenDate() Tests if this term has an open date when published offerings are finalized.
boolean	hasRegistrationPeriod() Tests if this term has a registration period.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getDisplayLabel

DisplayText getDisplayLabel()

Gets a display label for this term which may be less formal than the display name.

Returns:

the term label

Compliance:

mandatory - This method must be implemented.

hasOpenDate

boolean hasOpenDate()

Tests if this term has an open date when published offerings are finalized.

Returns:

true if there is an open date associated with this term, false otherwise

Compliance:

mandatory - This method must be implemented.

getOpenDate

DateTime getOpenDate()

Gets the open date when published offerings are finalized.

Returns:

the open date

Throws:

IllegalStateException - hasOpenDate() is false

Compliance:

mandatory - This method must be implemented.

hasRegistrationPeriod

boolean hasRegistrationPeriod()

Tests if this term has a registration period.

Returns:

true if there is a registration period associated with this term, false otherwise

Compliance:

mandatory - This method must be implemented.

getRegistrationStart

DateTime getRegistrationStart()

Gets the start of the registration period.

Returns:

the start date

Throws:

IllegalStateException - hasRegistrationPeriod() is false

Compliance:

mandatory - This method must be implemented.

getRegistrationEnd

DateTime getRegistrationEnd()

Gets the end of the registration period.

Returns:

the end date

Throws:

IllegalStateException - hasRegistrationPeriod() is false

Compliance:

mandatory - This method must be implemented.

getClassesStart

DateTime getClassesStart()

Gets the start of classes.

Returns:

the start date

Compliance:

mandatory - This method must be implemented.

getClassesEnd

DateTime getClassesEnd()

Gets the end of classes.

Returns:

the end date

Compliance:

mandatory - This method must be implemented.

hasAddDropDate

boolean hasAddDropDate()

Tests if this term has an add/drop date.

Returns:

true if there is an add/drop date associated with this term, false otherwise

Compliance:

mandatory - This method must be implemented.

getAddDate

DateTime getAddDate()

Gets the add/drop date.

Returns:

the add/drop date

Throws:

IllegalStateException - hasAddDropDate() is false

Compliance:

mandatory - This method must be implemented.

getDropDate

DateTime getDropDate()

Gets the add/drop date.

Returns:

the add/drop date

Throws:

IllegalStateException - hasAddDropDate() is false

Compliance:

mandatory - This method must be implemented.

hasFinalExamPeriod

boolean hasFinalExamPeriod()

Tests if this term has a final eam period.

Returns:

true if there is a final exam period associated with this term, false otherwise

Compliance:

mandatory - This method must be implemented.

getFinalExamStart

DateTime getFinalExamStart()

Gets the start of the final exam period.

Returns:

the start date

Throws:

IllegalStateException - hasFinalExamPeriod() is false

Compliance:

mandatory - This method must be implemented.

getFinalExamEnd

DateTime getFinalExamEnd()

Gets the end of the final exam period.

Returns:

the end date

Throws:

IllegalStateException - hasFinalExamPeriod() is false

Compliance:

mandatory - This method must be implemented.

hasCloseDate

boolean hasCloseDate()

Tests if this term has a close date when results from course offerings are finalized.

Returns:

true if there is a close date associated with this term, false otherwise

Compliance:

mandatory - This method must be implemented.

getCloseDate

DateTime getCloseDate()

Gets the close date when results of course offerings are finalized.

Returns:

the close date

Throws:

IllegalStateException - hasCloseDate() is false

Compliance:

mandatory - This method must be implemented.

getTermRecord

TermRecord getTermRecord(Type termRecordType)
                         throws OperationFailedException

Gets the term record corresponding to the given Term record Type. This method is used to retrieve an object implementing the requested record. The termRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(termRecordType) is true .

Parameters:

termRecordType - the type of term record to retrieve

Returns:

the term record

Throws:

NullArgumentException - termRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(termRecordType) is false

Compliance:

mandatory - This method must be implemented.