public interface ProgramOffering extends OsidRelationship
A ProgramOffering
represents a learning unit offered
duing a Term.
Scheduling information of a
ProgramOffering
is maintained at the Activity
level
resulting in a composite RecurringEvent.
A separate
Calendar
of activities can be made available through orchestration
of the Calendaring OSID.
Modifier and Type | Method and Description |
---|---|
boolean |
earnsCredentials()
Tests if completion of this program results in credentials awarded.
|
IdList |
getCompletionRequirementIds()
Gets the
Requisite Ids for the program
completion. |
RequisiteList |
getCompletionRequirements()
Gets the requisites for the program completion.
|
DisplayText |
getCompletionRequirementsInfo()
Gets the an informational string for the program completion.
|
IdList |
getCredentialIds()
Gets the awarded credential
Ids. |
CredentialList |
getCredentials()
Gets the awarded credentials.
|
long |
getMaximumSeats()
Gets the maximum number of students this offering can have.
|
long |
getMinimumSeats()
Gets the minimum number of students this offering can have.
|
java.lang.String |
getNumber()
Gets the program number which is a label generally used to index the
program offering in a catalog, such as 16.
|
Program |
getProgram()
Gets the canonical program associated with this program offering.
|
Id |
getProgramId()
Gets the canonical program
Id associated with this
program offering. |
ProgramOfferingRecord |
getProgramOfferingRecord(Type programOfferingRecordType)
Gets the program offering record corresponding to the given
ProgramOffering record Type. |
IdList |
getSponsorIds()
Gets the sponsor
Ids. |
ResourceList |
getSponsors()
Gets the sponsors.
|
Term |
getTerm()
Gets the
Term of this offering. |
Id |
getTermId()
Gets the
Id of the Term of this
offering. |
DisplayText |
getTitle()
Gets the formal title of this program offering.
|
java.lang.String |
getURL()
Gets an external resource, such as a class web site, associated with
this offering.
|
boolean |
hasCompletionRequirements()
Tests if this program has a rule for the program completion.
|
boolean |
hasSponsors()
Tests if this program offering has sponsors.
|
boolean |
requiresRegistration()
Tests if this program offering requires advanced registration.
|
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getProgramId()
Id
associated with this
program offering. Id
mandatory
- This method must be implemented. Program getProgram() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getTermId()
Id
of the Term
of this
offering. Term
Id
mandatory
- This method must be implemented. Term getTerm() throws OperationFailedException
Term
of this offering.OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DisplayText getTitle()
mandatory
- This method must be implemented. java.lang.String getNumber()
mandatory
- This method must be implemented. boolean hasSponsors()
true
if this program 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. DisplayText getCompletionRequirementsInfo()
mandatory
- This method must be implemented. boolean hasCompletionRequirements()
true
if this program has a completion rule,
false
otherwisemandatory
- This method must be implemented. IdList getCompletionRequirementIds()
Requisite
Ids
for the program
completion. Ids
IllegalStateException
-
hasCompletionRequirements()
is false
mandatory
- This method must be implemented. RequisiteList getCompletionRequirements() throws OperationFailedException
Requisite
is an AND
term and must be true for the
requirements to be satisifed.IllegalStateException
-
hasCompletionRequirements()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean earnsCredentials()
true
if this program earns credentials,
false
otherwisemandatory
- This method must be implemented. IdList getCredentialIds()
Ids.
Ids
IllegalStateException
- earnsCredentials()
is false
mandatory
- This method must be implemented. CredentialList getCredentials() throws OperationFailedException
IllegalStateException
- earnsCredentials()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean requiresRegistration()
true
if this progranm offering requires advance
registration, false
otherwisemandatory
- This method must be implemented. long getMinimumSeats()
IllegalStateException
- requiresRegistration()
is false
mandatory
- This method must be implemented. long getMaximumSeats()
IllegalStateException
- requiresRegistration()
is false
mandatory
- This method must be implemented. java.lang.String getURL()
mandatory
- This method must be implemented. ProgramOfferingRecord getProgramOfferingRecord(Type programOfferingRecordType) throws OperationFailedException
ProgramOffering
record Type.
This method is
used to retrieve an object implementing the requested record. The
programOfferingRecordType
may be the Type
returned in getRecordTypes()
or any of its
parents in a Type
hierarchy where
hasRecordType(programOfferingRecordType)
is true
.programOfferingRecordType
- the type of program offering record
to retrieveNullArgumentException
-
programOfferingRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(programOfferingRecordType)
is
false
mandatory
- This method must be implemented.