public interface Offering extends OsidRelationship
An Offering
is an OsidRelationship
between a CanonicalUnit
and a TimePeriod.
Modifier and Type | Method and Description |
---|---|
CanonicalUnit |
getCanonicalUnit()
Gets the canonical of this offering.
|
Id |
getCanonicalUnitId()
Gets the
Id of the canonical unit. |
java.lang.String |
getCode()
Gets the code for this offering.
|
OfferingRecord |
getOfferingRecord(Type offeringRecordType)
Gets the record corresponding to the given
Offering
record Type. |
IdList |
getResultOptionIds()
Gets the various result option
Ids allowed for results. |
GradeSystemList |
getResultOptions()
Gets the various result options allowed for this offering.
|
IdList |
getScheduleIds()
Gets the schedule
Ids associated with this offering. |
ScheduleList |
getSchedules()
Gets the schedules associated with this offering.
|
IdList |
getSponsorIds()
Gets the sponsor
Ids. |
ResourceList |
getSponsors()
Gets the sponsors.
|
TimePeriod |
getTimePeriod()
Gets the time period of this offering
|
Id |
getTimePeriodId()
Gets the
Id of the time period. |
DisplayText |
getTitle()
Gets the title for this offering.
|
boolean |
hasResults()
Tests if this offering has results when offered.
|
boolean |
hasSponsors()
Tests if this offering has sponsors.
|
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getCanonicalUnitId()
Id
of the canonical unit. Id
mandatory
- This method must be implemented. CanonicalUnit getCanonicalUnit() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getTimePeriodId()
Id
of the time period. Id
mandatory
- This method must be implemented. TimePeriod getTimePeriod() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DisplayText getTitle()
mandatory
- This method must be implemented. java.lang.String getCode()
mandatory
- This method must be implemented. boolean hasResults()
true
if this offering 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 offering 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. IdList getScheduleIds()
Ids
associated with this offering. Ids
mandatory
- This method must be implemented. ScheduleList getSchedules() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. OfferingRecord getOfferingRecord(Type offeringRecordType) throws OperationFailedException
Offering
record Type.
This method is used to retrieve an object
implementing the requested record. The offeringRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(offeringRecordType)
is true
.offeringRecordType
- the type of offering record to retrieveNullArgumentException
- offeringRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(offeringRecordType)
is false
mandatory
- This method must be implemented.