Interface ControllerBatchForm

All Superinterfaces:

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

public interface ControllerBatchForm
extends ControllerForm

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

Methods inherited from interface ControllerForm

clearAddress, clearDiscreetStates, clearModel, clearToggleable, clearVariable, clearVariableMaximum, clearVariableMinimum, clearVariablePercentage, clearVersion, getAddressMetadata, getControllerFormRecord, getDiscreetStatesMetadata, getModelMetadata, getToggleableMetadata, getVariableByPercentageMetadata, getVariableMaximumMetadata, getVariableMetadata, getVariableMinimumMetadata, getVersionMetadata, setAddress, setDiscreetStates, setModel, setToggleable, setVariable, setVariableMaximum, setVariableMinimum, setVariablePercentage, setVersion

Modifier and Type	Method	Description
void	clearAddress()	Removes the address.
void	clearDiscreetStates()	Removes the discreet states.
void	clearModel()	Removes the model.
void	clearToggleable()	Removes the toggle.
void	clearVariable()	Removes the variable flag.
void	clearVariableMaximum()	Removes the maximum variable amount.
void	clearVariableMinimum()	Removes the minimum variable amount.
void	clearVariablePercentage()	Removes the variable by percentage flag.
void	clearVersion()	Removes the version.
Metadata	getAddressMetadata()	Gets the metadata for the address.
ControllerFormRecord	getControllerFormRecord(Type controllerRecordType)	Gets the ControllerFormRecord corresponding to the given controller record Type .
Metadata	getDiscreetStatesMetadata()	Gets the metadata for the discreet states.
Metadata	getModelMetadata()	Gets the metadata for the model.
Metadata	getToggleableMetadata()	Gets the metadata for the toggle capability.
Metadata	getVariableByPercentageMetadata()	Gets the metadata for the variable by percentage capability.
Metadata	getVariableMaximumMetadata()	Gets the metadata for the maximum variable amount.
Metadata	getVariableMetadata()	Gets the metadata for the variable capability.
Metadata	getVariableMinimumMetadata()	Gets the metadata for the minimum variable amount.
Metadata	getVersionMetadata()	Gets the metadata for the version.
void	setAddress(String address)	Sets the address.
void	setDiscreetStates(Id[] stateIds)	Sets the maximum variable amount.
void	setModel(Id modelId)	Sets the model.
void	setToggleable(boolean toggle)	Sets the toggleable capability.
void	setVariable(boolean variable)	Sets the variable capability.
void	setVariableMaximum(BigDecimal amount)	Sets the maximum variable amount.
void	setVariableMinimum(BigDecimal amount)	Sets the minimum variable amount.
void	setVariablePercentage(boolean percentage)	Sets the variable bt percentage capability.
void	setVersion(Version version)	Sets the version.

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

getControllerId

Id getControllerId()

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

Returns:

the controller Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.