org.osid.course.program

Interface ProgramForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, Suppliable

All Known Subinterfaces:

ProgramBatchForm

public interface ProgramForm
extends OsidObjectForm, OsidOperableForm

This is the form for creating and updating Programs. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ProgramAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCompletionRequirements() Removes the completion requirements requisites.
void	clearCompletionRequirementsInfo() Removes the completion requirements information.
void	clearCredentials() Removes the credentials.
void	clearNumber() Removes the program number.
void	clearSponsors() Removes the sponsors.
void	clearTitle() Removes the title.
Metadata	getCompletionRequirementsInfoMetadata() Gets the metadata for a completion requirements informational string.
Metadata	getCompletionRequirementsMetadata() Gets the metadata for a completion requirements requisites.
Metadata	getCredentialsMetadata() Gets the metadata for a set of credentials.
Metadata	getNumberMetadata() Gets the metadata for a program number.
ProgramFormRecord	getProgramFormRecord(Type programRecordType) Gets the ProgramFormRecord corresponding to the given program record Type.
Metadata	getSponsorsMetadata() Gets the metadata for a set of sponsors.
Metadata	getTitleMetadata() Gets the metadata for a program title.
void	setCompletionRequirements(Id[] requisiteIds) Sets the completion requirements requisites.
void	setCompletionRequirementsInfo(java.lang.String requirements) Sets the completion requirements information.
void	setCredentials(Id[] credentialIds) Sets the credentials.
void	setNumber(java.lang.String number) Sets the program number.
void	setSponsors(Id[] resourceIds) Sets the sponsors.
void	setTitle(java.lang.String title) Sets the title.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Method Detail

getTitleMetadata

Metadata getTitleMetadata()

Gets the metadata for a program title.

Returns:

metadata for the title

Compliance:

mandatory - This method must be implemented.

setTitle

void setTitle(java.lang.String title)

Sets the title.

Parameters:

title - the new title

Throws:

InvalidArgumentException - title is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - title is null

Compliance:

mandatory - This method must be implemented.

clearTitle

void clearTitle()

Removes the title.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getNumberMetadata

Metadata getNumberMetadata()

Gets the metadata for a program number.

Returns:

metadata for the program number

Compliance:

mandatory - This method must be implemented.

setNumber

void setNumber(java.lang.String number)

Sets the program number.

Parameters:

number - the new program number

Throws:

InvalidArgumentException - number is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - number is null

Compliance:

mandatory - This method must be implemented.

clearNumber

void clearNumber()

Removes the program number.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getSponsorsMetadata

Metadata getSponsorsMetadata()

Gets the metadata for a set of sponsors.

Returns:

metadata for the sponsors

Compliance:

mandatory - This method must be implemented.

setSponsors

void setSponsors(Id[] resourceIds)

Sets the sponsors.

Parameters:

resourceIds - the new sponsors

Throws:

InvalidArgumentException - resourceIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceIds is null

Compliance:

mandatory - This method must be implemented.

clearSponsors

void clearSponsors()

Removes the sponsors.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCompletionRequirementsInfoMetadata

Metadata getCompletionRequirementsInfoMetadata()

Gets the metadata for a completion requirements informational string.

Returns:

metadata for the prerequisite information

Compliance:

mandatory - This method must be implemented.

setCompletionRequirementsInfo

void setCompletionRequirementsInfo(java.lang.String requirements)

Sets the completion requirements information.

Parameters:

requirements - the new requirements information

Throws:

InvalidArgumentException - requirements is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - requirements is null

Compliance:

mandatory - This method must be implemented.

clearCompletionRequirementsInfo

void clearCompletionRequirementsInfo()

Removes the completion requirements information.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCompletionRequirementsMetadata

Metadata getCompletionRequirementsMetadata()

Gets the metadata for a completion requirements requisites.

Returns:

metadata for the requisites

Compliance:

mandatory - This method must be implemented.

setCompletionRequirements

void setCompletionRequirements(Id[] requisiteIds)

Sets the completion requirements requisites.

Parameters:

requisiteIds - the new requisites

Throws:

InvalidArgumentException - ruleId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - requisiteIds is null

Compliance:

mandatory - This method must be implemented.

clearCompletionRequirements

void clearCompletionRequirements()

Removes the completion requirements requisites.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCredentialsMetadata

Metadata getCredentialsMetadata()

Gets the metadata for a set of credentials.

Returns:

metadata for the credentials

Compliance:

mandatory - This method must be implemented.

setCredentials

void setCredentials(Id[] credentialIds)

Sets the credentials.

Parameters:

credentialIds - the new credentials

Throws:

InvalidArgumentException - gradeSystemIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - credentialIds is null

Compliance:

mandatory - This method must be implemented.

clearCredentials

void clearCredentials()

Removes the credentials.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getProgramFormRecord

ProgramFormRecord getProgramFormRecord(Type programRecordType)
                                       throws OperationFailedException

Gets the ProgramFormRecord corresponding to the given program record Type.

Parameters:

programRecordType - a program record type

Returns:

the program form record

Throws:

NullArgumentException - programRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programRecordType) is false

Compliance:

mandatory - This method must be implemented.