org.osid.checklist.mason

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

Methods

Modifier and Type	Method and 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 org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

Methods inherited from interface org.osid.OsidObjectForm

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

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

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

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Method Detail

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.