Interface StockForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable

All Known Subinterfaces:

StockBatchForm

public interface StockForm
extends OsidObjectForm, OsidFederateableForm

This is the form for creating and updating Stocks. Like all OsidForms, various data elements may be set here for use in the create and update methods in the StockAdminSession. 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	clearLocationDescription()	Removes the location description.
void	clearLocations()	Removes the locations.
void	clearModels()	Removes the models.
void	clearSKU()	Removes the SKU.
Metadata	getLocationDescriptionMetadata()	Gets the metadata for location text.
Metadata	getLocationsMetadata()	Gets the metadata for locations in this stock.
Metadata	getModelsMetadata()	Gets the metadata for models in this stock.
Metadata	getSKUMetadata()	Gets the metadata for sku.
StockFormRecord	getStockFormRecord(Type stockRecordType)	Gets the StockFormRecord corresponding to the given stock record Type.
void	setLocationDescription(String location)	Sets the location string.
void	setLocations(Id[] locations)	Sets the locations.
void	setModels(Id[] models)	Sets the models.
void	setSKU(String sku)	Sets the SKU.

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.

Method Details

getSKUMetadata

Metadata getSKUMetadata()

Gets the metadata for sku.

Returns:

metadata for the sku

Compliance:

mandatory - This method must be implemented.

setSKU

void setSKU(String sku)

Sets the SKU.

Parameters:

sku - the new SKU

Throws:

InvalidArgumentException - sku is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - sku is null

Compliance:

mandatory - This method must be implemented.

clearSKU

void clearSKU()

Removes the SKU.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getModelsMetadata

Metadata getModelsMetadata()

Gets the metadata for models in this stock.

Returns:

metadata for the models

Compliance:

mandatory - This method must be implemented.

setModels

void setModels(Id[] models)

Sets the models.

Parameters:

models - the new models

Throws:

InvalidArgumentException - models is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - models is null

Compliance:

mandatory - This method must be implemented.

clearModels

void clearModels()

Removes the models.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getLocationDescriptionMetadata

Metadata getLocationDescriptionMetadata()

Gets the metadata for location text.

Returns:

metadata for the location string

Compliance:

mandatory - This method must be implemented.

setLocationDescription

void setLocationDescription(String location)

Sets the location string.

Parameters:

location - the new location description

Throws:

InvalidArgumentException - location is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - location is null

Compliance:

mandatory - This method must be implemented.

clearLocationDescription

void clearLocationDescription()

Removes the location description.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getLocationsMetadata

Metadata getLocationsMetadata()

Gets the metadata for locations in this stock.

Returns:

metadata for the locations

Compliance:

mandatory - This method must be implemented.

setLocations

void setLocations(Id[] locations)

Sets the locations.

Parameters:

locations - the new locations

Throws:

InvalidArgumentException - locations is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - locations is null

Compliance:

mandatory - This method must be implemented.

clearLocations

void clearLocations()

Removes the locations.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getStockFormRecord

StockFormRecord getStockFormRecord(Type stockRecordType)
                            throws OperationFailedException

Gets the StockFormRecord corresponding to the given stock record Type.

Parameters:

stockRecordType - a stock record type

Returns:

the stock form record

Throws:

NullArgumentException - stockRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stockRecordType) is false

Compliance:

mandatory - This method must be implemented.