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.
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.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
DisplayText getDisplayLabel()
mandatory
- This method must be implemented. boolean hasOpenDate()
true
if there is an open date associated with
this term, false
otherwisemandatory
- This method must be implemented. DateTime getOpenDate()
IllegalStateException
- hasOpenDate()
is
false
mandatory
- This method must be implemented. boolean hasRegistrationPeriod()
true
if there is a registration period
associated with this term, false
otherwisemandatory
- This method must be implemented. DateTime getRegistrationStart()
IllegalStateException
- hasRegistrationPeriod()
is false
mandatory
- This method must be implemented. DateTime getRegistrationEnd()
IllegalStateException
- hasRegistrationPeriod()
is false
mandatory
- This method must be implemented. DateTime getClassesStart()
mandatory
- This method must be implemented. DateTime getClassesEnd()
mandatory
- This method must be implemented. boolean hasAddDropDate()
true
if there is an add/drop date associated
with this term, false
otherwisemandatory
- This method must be implemented. DateTime getAddDate()
IllegalStateException
- hasAddDropDate()
is false
mandatory
- This method must be implemented. DateTime getDropDate()
IllegalStateException
- hasAddDropDate()
is false
mandatory
- This method must be implemented. boolean hasFinalExamPeriod()
true
if there is a final exam period associated
with this term, false
otherwisemandatory
- This method must be implemented. DateTime getFinalExamStart()
IllegalStateException
- hasFinalExamPeriod()
is false
mandatory
- This method must be implemented. DateTime getFinalExamEnd()
IllegalStateException
- hasFinalExamPeriod()
is false
mandatory
- This method must be implemented. boolean hasCloseDate()
true
if there is a close date associated with
this term, false
otherwisemandatory
- This method must be implemented. DateTime getCloseDate()
IllegalStateException
- hasCloseDate()
is false
mandatory
- This method must be implemented. TermRecord getTermRecord(Type termRecordType) throws OperationFailedException
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
.termRecordType
- the type of term record to retrieveNullArgumentException
- termRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(termRecordType)
is false
mandatory
- This method must be implemented.