public interface CanonicalUnit extends OsidObject, Operable
A Canonical Unit
is an approved item to be offered.
Modifier and Type | Method and Description |
---|---|
CanonicalUnitRecord |
getCanonicalUnitRecord(Type canonicalUnitRecordType)
Gets the record corresponding to the given
CanonicalUnit
record Type. |
java.lang.String |
getCode()
Gets the code for this canonical unit.
|
IdList |
getOfferedCyclicTimePeriodIds()
Gets the cyclic period
Ids in which this CU can be
offered. |
CyclicTimePeriodList |
getOfferedCyclicTimePeriods()
Gets the cyclic periods in which this CU can be offered.
|
IdList |
getResultOptionIds()
Gets the various result option
Ids allowed for results. |
GradeSystemList |
getResultOptions()
Gets the various result options allowed for this canonical unit.
|
IdList |
getSponsorIds()
Gets the sponsor
Ids. |
ResourceList |
getSponsors()
Gets the sponsors.
|
DisplayText |
getTitle()
Gets the title for this canonical unit.
|
boolean |
hasResults()
Tests if this canonical has results when offered.
|
boolean |
hasSponsors()
Tests if this canonical has sponsors.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
DisplayText getTitle()
mandatory
- This method must be implemented. java.lang.String getCode()
mandatory
- This method must be implemented. IdList getOfferedCyclicTimePeriodIds()
Ids
in which this CU can be
offered. If there are no time cycles, then it can be offered any time. Ids
mandatory
- This method must be implemented. CyclicTimePeriodList getOfferedCyclicTimePeriods() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasResults()
true
if this canonical has results,
false
otherwisemandatory
- This method must be implemented. IdList getResultOptionIds()
Ids
allowed for results. Ids
IllegalStateException
- hasResults()
is
false
mandatory
- This method must be implemented. GradeSystemList getResultOptions() throws OperationFailedException
IllegalStateException
- hasResults()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasSponsors()
true
if this canonical has sponsors,
false
otherwisemandatory
- This method must be implemented. IdList getSponsorIds()
Ids.
Ids
IllegalStateException
- hasSponsors()
is
false
mandatory
- This method must be implemented. ResourceList getSponsors() throws OperationFailedException
IllegalStateException
- hasSponsors()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. CanonicalUnitRecord getCanonicalUnitRecord(Type canonicalUnitRecordType) throws OperationFailedException
CanonicalUnit
record Type.
This method is used to retrieve an
object implementing the requested record. The
canonicalUnitRecordType
may be the Type
returned in getRecordTypes()
or any of its parents in a
Type
hierarchy where
hasRecordType(canonicalUnitRecordType)
is true
.canonicalUnitRecordType
- the type of canonical unit record to
retrieveNullArgumentException
- canonicalUnitRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(canonicalUnitRecordType)
is false
mandatory
- This method must be implemented.