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

Modifier and Type	Method	Description
void	clearCompletionRequirements()	Removes the completion requirements.
void	clearCompletionRequirementsInfo()	Removes the completion requirements information.
void	clearCredentials()	Removes the credentials.
void	clearLearningObjectives()	Removes the learning objectives.
void	clearNumber()	Removes the program number.
void	clearParentProgram()	Removes the parent program.
void	clearSponsors()	Removes the sponsors.
void	clearTargetAudiences()	Removes the target audiences.
void	clearTitle()	Removes the title.
Metadata	getCompletionRequirementsInfoMetadata()	Gets the metadata for a completion requirements informational string.
Metadata	getCompletionRequirementsMetadata()	Gets the metadata for the completion requirements.
Metadata	getCredentialsMetadata()	Gets the metadata for a set of credentials.
Metadata	getLearningObjectivesMetadata()	Gets the metadata for the learning objectives.
Metadata	getNumberMetadata()	Gets the metadata for a program number.
Metadata	getParentProgramMetadata()	Gets the metadata for the parent program.
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	getTargetAudiencesMetadata()	Gets the metadata for a set of target audiences.
Metadata	getTitleMetadata()	Gets the metadata for a program title.
void	setCompletionRequirements(Id[] requisiteIds)	Sets the completion requirements.
void	setCompletionRequirementsInfo(String requirements)	Sets the completion requirements information.
void	setCredentials(Id[] credentialIds)	Sets the credentials.
void	setLearningObjectives(Id[] objectiveIds)	Sets the learning objectives.
void	setNumber(String number)	Sets the program number.
void	setParentProgram(Id programId)	Sets the parent program.
void	setSponsors(Id[] resourceIds)	Sets the sponsors.
void	setTargetAudiences(Id[] resourceIds)	Sets the target audiences.
void	setTitle(String title)	Sets the title.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Modifier and Type	Method	Description
void	clearDisabled()	Removes the administratively disabled flag.
void	clearEnabled()	Removes the administratively enabled flag.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled flag.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled flag.
void	setDisabled(boolean disabled)	Sets the administratively disabled flag.
void	setEnabled(boolean enabled)	Sets the administratively enabled flag.

Method Details

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

getParentProgramMetadata

Metadata getParentProgramMetadata()

Gets the metadata for the parent program.

Returns:

metadata for the parent program

Compliance:

mandatory - This method must be implemented.

setParentProgram

void setParentProgram(Id programId)

Sets the parent program.

Parameters:

programId - the new parent program

Throws:

InvalidArgumentException - programId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - programId is null

Compliance:

mandatory - This method must be implemented.

clearParentProgram

void clearParentProgram()

Removes the parent program.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getLearningObjectivesMetadata

Metadata getLearningObjectivesMetadata()

Gets the metadata for the learning objectives.

Returns:

metadata for the learning objectives

Compliance:

mandatory - This method must be implemented.

setLearningObjectives

void setLearningObjectives(Id[] objectiveIds)

Sets the learning objectives.

Parameters:

objectiveIds - the new learning objectives

Throws:

InvalidArgumentException - objectiveIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - objectiveIds is null

Compliance:

mandatory - This method must be implemented.

clearLearningObjectives

void clearLearningObjectives()

Removes the learning objectives.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getTargetAudiencesMetadata

Metadata getTargetAudiencesMetadata()

Gets the metadata for a set of target audiences.

Returns:

metadata for the target audiences

Compliance:

mandatory - This method must be implemented.

setTargetAudiences

void setTargetAudiences(Id[] resourceIds)

Sets the target audiences.

Parameters:

resourceIds - the new target audiences

Throws:

InvalidArgumentException - resourceIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceIds is null

Compliance:

mandatory - This method must be implemented.

clearTargetAudiences

void clearTargetAudiences()

Removes the target audiences.

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(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 the completion requirements.

Returns:

metadata for the requisites

Compliance:

mandatory - This method must be implemented.

setCompletionRequirements

void setCompletionRequirements(Id[] requisiteIds)

Sets the completion requirements.

Parameters:

requisiteIds - the new requisites

Throws:

InvalidArgumentException - requisiteIds 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.

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