org.osid.course.program

Interface Program

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidObject

public interface Program
extends OsidObject, Operable

A Program represents a canonical program and instantiated for offering through the creation of a ProgramOffering.

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.
java.lang.String	getNumber() Gets the program number which is a label generally used to index the program in a catalog, such as "16c."
ProgramRecord	getProgramRecord(Type programRecordType) Gets the program record corresponding to the given Program record Type.
IdList	getSponsorIds() Gets the sponsor Ids.
ResourceList	getSponsors() Gets the sponsors.
DisplayText	getTitle() Gets the formal title of this program.
boolean	hasCompletionRequirements() Tests if this program has a rule for the program completion.
boolean	hasSponsors() Tests if this program has sponsors.

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.Operable

isActive, isDisabled, isEnabled, isOperational

Method Detail

getTitle

DisplayText getTitle()

Gets the formal title of this program. It may be the same as the display name or it may be used to more formally label the program. 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 in a catalog, such as "16c."

Returns:

the program number

Compliance:

mandatory - This method must be implemented.

hasSponsors

boolean hasSponsors()

Tests if this program has sponsors.

Returns:

true if this program 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.

getProgramRecord

ProgramRecord getProgramRecord(Type programRecordType)
                               throws OperationFailedException

Gets the program record corresponding to the given Program record Type. This method is used to retrieve an object implementing the requested record. The programRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(programRecordType) is true .

Parameters:

programRecordType - the type of program record to retrieve

Returns:

the program record

Throws:

NullArgumentException - programRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programRecordType) is false

Compliance:

mandatory - This method must be implemented.