Interface | osid.offering.CanonicalUnit | ||
---|---|---|---|
Implements | osid.OsidObject | ||
osid.Operable | |||
Description |
A | ||
Method | getTitle | ||
Description |
Gets the title for this canonical unit. | ||
Return | osid.locale.DisplayText | the title | |
Compliance | mandatory | This method must be implemented. | |
Method | getCode | ||
Description |
Gets the code for this canonical unit. | ||
Return | string | the code | |
Compliance | mandatory | This method must be implemented. | |
Method | getOfferedCyclicTimePeriodIds | ||
Description |
Gets the cyclic period | ||
Return | osid.id.IdList | a list of cyclic period Ids | |
Compliance | mandatory | This method must be implemented. | |
Method | getOfferedCyclicTimePeriods | ||
Description |
Gets the cyclic periods in which this CU can be offered. If there are no time cycles, then it can be offered any time. | ||
Return | osid.calendaring.cycle.CyclicTimePeriodList | a list of cyclic periods | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | hasResults | ||
Description |
Tests if this canonical has results when offered. | ||
Return | boolean | true if this canonical has results, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getResultOptionIds | ||
Description |
Gets the various result option | ||
Return | osid.id.IdList | the returned list of grading option Ids | |
Errors | ILLEGAL_STATE | hasResults() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getResultOptions | ||
Description |
Gets the various result options allowed for this canonical unit. | ||
Return | osid.grading.GradeSystemList | the returned list of grading options | |
Errors | ILLEGAL_STATE | hasResults() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | hasSponsors | ||
Description |
Tests if this canonical has sponsors. | ||
Return | boolean | true if this canonical has sponsors, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSponsorIds | ||
Description |
Gets the sponsor | ||
Return | osid.id.IdList | the sponsor Ids | |
Errors | ILLEGAL_STATE | hasSponsors() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getSponsors | ||
Description |
Gets the sponsors. | ||
Return | osid.resource.ResourceList | the sponsors | |
Errors | ILLEGAL_STATE | hasSponsors() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitRecord | ||
Description |
Gets the record corresponding to the given | ||
Parameters | osid.type.Type | canonicalUnitRecordType | the type of canonical unit record to retrieve |
Return | osid.offering.records.CanonicalUnitRecord | the canonical unit record | |
Errors | NULL_ARGUMENT | canonicalUnitRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(canonicalUnitRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |