Interface CanonicalUnitBatchForm

All Superinterfaces:

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

public interface CanonicalUnitBatchForm
extends CanonicalUnitForm

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

Methods inherited from interface CanonicalUnitForm

clearCode, clearOfferedCyclicTimePeriods, clearResultOptions, clearSponsors, clearTitle, getCanonicalUnitFormRecord, getCodeMetadata, getOfferedCyclicTimePeriodsMetadata, getResultOptionsMetadata, getSponsorsMetadata, getTitleMetadata, setCode, setOfferedCyclicTimePeriods, setResultOptions, setSponsors, setTitle

Modifier and Type	Method	Description
void	clearCode()	Clears the code.
void	clearOfferedCyclicTimePeriods()	Clears the cyclic time periods.
void	clearResultOptions()	Removes the grading options.
void	clearSponsors()	Removes the sponsors.
void	clearTitle()	Clears the title.
CanonicalUnitFormRecord	getCanonicalUnitFormRecord(Type canonicalUnitRecordType)	Gets the CanonicalUnitFormRecord interface corresponding to the given canonical unit record Type .
Metadata	getCodeMetadata()	Gets the metadata for a given name.
Metadata	getOfferedCyclicTimePeriodsMetadata()	Gets the metadata for a the cyclic time periods.
Metadata	getResultOptionsMetadata()	Gets the metadata for the grading options.
Metadata	getSponsorsMetadata()	Gets the metadata for the sponsors.
Metadata	getTitleMetadata()	Gets the metadata for a title.
void	setCode(String code)	Sets the code.
void	setOfferedCyclicTimePeriods(Id[] cyclicTimePeriodIds)	Sets the cyclic time periods.
void	setResultOptions(Id[] gradeSystemIds)	Sets the grading options.
void	setSponsors(Id[] sponsorIds)	Sets the sponsors.
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

getCanonicalUnitId

Id getCanonicalUnitId()

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

Returns:

the canonical unit Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.