Interface TodoProducerForm

All Superinterfaces:

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

public interface TodoProducerForm
extends OsidRuleForm

This is the form for creating and updating TodoProducers . Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the TodoProducerAdminSession . 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	clearCreationRule()	Clears the creation rule flag.
void	clearCyclicEvent()	Clears the cyclic event.
void	clearStock()	Clears the stock.
void	clearStockLevel()	Clears the stock level.
Metadata	getCreationRuleMetadata()	Gets the metadata for a creation rule flag.
Metadata	getCyclicEventMetadata()	Gets the metadata for a cyclic event.
Metadata	getStockLevelMetadata()	Gets the metadata for the stock level.
Metadata	getStockMetadata()	Gets the metadata for a cyclic event.
TodoProducerFormRecord	getTodoProducerFormRecord(Type todoProducerRecordType)	Gets the TodoProducerFormRecord corresponding to the given todo producer record Type .
void	setCreationRule(boolean creation)	Sets the cyclic event.
void	setCyclicEvent(Id cyclicEventId)	Sets the cyclic event.
void	setStock(Id stockId)	Sets the stock.
void	setStockLevel(long level)	Sets the stock level.

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 OsidRuleForm

clearConditionRecordTypes, clearRule, getConditionRecordTypesMetadata, getRuleMetadata, setConditionRecordTypes, setRule

Modifier and Type	Method	Description
void	clearConditionRecordTypes()	Clears the condition record types.
void	clearRule()	Removes the rule.
Metadata	getConditionRecordTypesMetadata()	Gets the metadata for the condition record types.
Metadata	getRuleMetadata()	Gets the metadata for an associated rule.
void	setConditionRecordTypes(Type[] conditionRecordTypes)	Sets the condition record types.
void	setRule(Id ruleId)	Sets a rule.

Method Details

getCreationRuleMetadata

Metadata getCreationRuleMetadata()

Gets the metadata for a creation rule flag.

Returns:

metadata for a creation operation

Compliance:

mandatory - This method must be implemented.

setCreationRule

void setCreationRule(boolean creation)

Sets the cyclic event.

Parameters:

creation - the new creationr ule flag

Throws:

InvalidArgumentException - creation is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearCreationRule

void clearCreationRule()

Clears the creation rule flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCyclicEventMetadata

Metadata getCyclicEventMetadata()

Gets the metadata for a cyclic event.

Returns:

metadata for a cyclic event

Compliance:

mandatory - This method must be implemented.

setCyclicEvent

void setCyclicEvent(Id cyclicEventId)

Sets the cyclic event.

Parameters:

cyclicEventId - the new cyclic event

Throws:

InvalidArgumentException - cyclicEventId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - cyclicEventId is null

Compliance:

mandatory - This method must be implemented.

clearCyclicEvent

void clearCyclicEvent()

Clears the cyclic event.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getStockMetadata

Metadata getStockMetadata()

Gets the metadata for a cyclic event.

Returns:

metadata for a cyclic event

Compliance:

mandatory - This method must be implemented.

setStock

void setStock(Id stockId)

Sets the stock.

Parameters:

stockId - the new stock

Throws:

InvalidArgumentException - stockId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - stockId is null

Compliance:

mandatory - This method must be implemented.

clearStock

void clearStock()

Clears the stock.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getStockLevelMetadata

Metadata getStockLevelMetadata()

Gets the metadata for the stock level.

Returns:

metadata for the stock level

Compliance:

mandatory - This method must be implemented.

setStockLevel

void setStockLevel(long level)

Sets the stock level.

Parameters:

level - the new stock level

Throws:

InvalidArgumentException - level is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearStockLevel

void clearStockLevel()

Clears the stock level.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getTodoProducerFormRecord

TodoProducerFormRecord getTodoProducerFormRecord(Type todoProducerRecordType)
                                          throws OperationFailedException

Gets the TodoProducerFormRecord corresponding to the given todo producer record Type .

Parameters:

todoProducerRecordType - a todo producer record type

Returns:

the todo producer form record

Throws:

NullArgumentException - todoProducerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(todoProducerRecordType) is false

Compliance:

mandatory - This method must be implemented.