org.osid.course.program

Interface ProgramOffering

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getProgramId

Id getProgramId()

Gets the canonical program Id associated with this program offering.

Returns:

the program Id

Compliance:

mandatory - This method must be implemented.

getProgram

Program getProgram()
                   throws OperationFailedException

Gets the canonical program associated with this program offering.

Returns:

the program

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getTermId

Id getTermId()

Gets the Id of the Term of this offering.

Returns:

the Term Id

Compliance:

mandatory - This method must be implemented.

getTerm

Term getTerm()
             throws OperationFailedException

Gets the Term of this offering.

Returns:

the term

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getTitle

DisplayText getTitle()

Gets the formal title of this program offering. It may be the same as the display name or it may be used to more formally label the program. A display name might be Course 16 where the title is Aeronautics & Astronautics.

Returns:

the program title

Compliance:

mandatory - This method must be implemented.

getNumber

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.

Returns:

the program number

Compliance:

mandatory - This method must be implemented.

hasSponsors

boolean hasSponsors()

Tests if this program offering has sponsors.

Returns:

true if this program offering has sponsors, false otherwise

Compliance:

mandatory - This method must be implemented.

getSponsorIds

IdList getSponsorIds()

Gets the sponsor Ids.

Returns:

the sponsor Ids

Throws:

IllegalStateException - hasSponsors() is false

Compliance:

mandatory - This method must be implemented.

getSponsors

ResourceList getSponsors()
                         throws OperationFailedException

Gets the sponsors.

Returns:

the sponsors

Throws:

IllegalStateException - hasSponsors() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getCompletionRequirementsInfo

DisplayText getCompletionRequirementsInfo()

Gets the an informational string for the program completion.

Returns:

the program completion

Compliance:

mandatory - This method must be implemented.

hasCompletionRequirements

boolean hasCompletionRequirements()

Tests if this program has a rule for the program completion.

Returns:

true if this program has a completion rule, false otherwise

Compliance:

mandatory - This method must be implemented.

getCompletionRequirementIds

IdList getCompletionRequirementIds()

Gets the Requisite Ids for the program completion.

Returns:

the completion requisite Ids

Throws:

IllegalStateException - hasCompletionRequirements() is false

Compliance:

mandatory - This method must be implemented.

getCompletionRequirements

RequisiteList getCompletionRequirements()
                                        throws OperationFailedException

Gets the requisites for the program completion. Each Requisite is an AND term and must be true for the requirements to be satisifed.

Returns:

the completion requisites

Throws:

IllegalStateException - hasCompletionRequirements() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

earnsCredentials

boolean earnsCredentials()

Tests if completion of this program results in credentials awarded.

Returns:

true if this program earns credentials, false otherwise

Compliance:

mandatory - This method must be implemented.

getCredentialIds

IdList getCredentialIds()

Gets the awarded credential Ids.

Returns:

the returned list of credential Ids

Throws:

IllegalStateException - earnsCredentials() is false

Compliance:

mandatory - This method must be implemented.

getCredentials

CredentialList getCredentials()
                              throws OperationFailedException

Gets the awarded credentials.

Returns:

the returned list of credentials

Throws:

IllegalStateException - earnsCredentials() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

requiresRegistration

boolean requiresRegistration()

Tests if this program offering requires advanced registration.

Returns:

true if this progranm offering requires advance registration, false otherwise

Compliance:

mandatory - This method must be implemented.

getMinimumSeats

long getMinimumSeats()

Gets the minimum number of students this offering can have.

Returns:

the minimum seats

Throws:

IllegalStateException - requiresRegistration() is false

Compliance:

mandatory - This method must be implemented.

getMaximumSeats

long getMaximumSeats()

Gets the maximum number of students this offering can have.

Returns:

the maximum seats

Throws:

IllegalStateException - requiresRegistration() is false

Compliance:

mandatory - This method must be implemented.

getURL

java.lang.String getURL()

Gets an external resource, such as a class web site, associated with this offering.

Returns:

a URL string

Compliance:

mandatory - This method must be implemented.

getProgramOfferingRecord

ProgramOfferingRecord getProgramOfferingRecord(Type programOfferingRecordType)
                                               throws OperationFailedException

Gets the program offering record corresponding to the given 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 .

Parameters:

programOfferingRecordType - the type of program offering record to retrieve

Returns:

the program offering record

Throws:

NullArgumentException - programOfferingRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programOfferingRecordType) is false

Compliance:

mandatory - This method must be implemented.