Interface ProgramBatchForm

All Superinterfaces:

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

public interface ProgramBatchForm
extends ProgramForm

This is the form for creating and updating programs in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ProgramBatchAdminSession . 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
Id	getProgramId()	Gets the Id of the program to be updated if this is an update transaction.

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.

Methods inherited from interface ProgramForm

clearCompletionRequirements, clearCompletionRequirementsInfo, clearCredentials, clearLearningObjectives, clearNumber, clearParentProgram, clearSponsors, clearTargetAudiences, clearTitle, getCompletionRequirementsInfoMetadata, getCompletionRequirementsMetadata, getCredentialsMetadata, getLearningObjectivesMetadata, getNumberMetadata, getParentProgramMetadata, getProgramFormRecord, getSponsorsMetadata, getTargetAudiencesMetadata, getTitleMetadata, setCompletionRequirements, setCompletionRequirementsInfo, setCredentials, setLearningObjectives, setNumber, setParentProgram, setSponsors, setTargetAudiences, setTitle

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.

Method Details

getProgramId

Id getProgramId()

Gets the Id of the program to be updated if this is an update transaction.

Returns:

the program Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.