Interface ProductForm

All Superinterfaces:

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

All Known Subinterfaces:

ProductBatchForm

public interface ProductForm
extends OsidObjectForm

This is the form for creating and updating Products .Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ProductAdminSession . 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	clearAvailability()	Clears the availability.
void	clearCode()	Clears the code.
void	clearPriceSchedules()	Clears the price schedules.
Metadata	getAvailabilityMetadata()	Gets the metadata for the availability.
Metadata	getCodeMetadata()	Gets the metadata for the code.
Metadata	getPriceSchedulesMetadata()	Gets the metadata for the price schedules.
ProductFormRecord	getProductFormRecord(Type productRecordType)	Gets the ProductFormRecord corresponding to the given product record Type .
void	setAvailability(long availability)	Sets the availability.
void	setCode(String code)	Sets the code.
void	setPriceSchedules(Id[] priceScheduleids)	Sets the price schedules.

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

getCodeMetadata

Metadata getCodeMetadata()

Gets the metadata for the code.

Returns:

metadata for the code

Compliance:

mandatory - This method must be implemented.

setCode

void setCode(String code)

Sets the code.

Parameters:

code - the new code

Throws:

InvalidArgumentException - code is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - code is null

Compliance:

mandatory - This method must be implemented.

clearCode

void clearCode()

Clears the code.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getPriceSchedulesMetadata

Metadata getPriceSchedulesMetadata()

Gets the metadata for the price schedules.

Returns:

metadata for the price schedules

Compliance:

mandatory - This method must be implemented.

setPriceSchedules

void setPriceSchedules(Id[] priceScheduleids)

Sets the price schedules.

Parameters:

priceScheduleids - the new price schedules

Throws:

InvalidArgumentException - priceScheduleIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - priceScheduleIds is null

Compliance:

mandatory - This method must be implemented.

clearPriceSchedules

void clearPriceSchedules()

Clears the price schedules.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getAvailabilityMetadata

Metadata getAvailabilityMetadata()

Gets the metadata for the availability.

Returns:

metadata for the availability

Compliance:

mandatory - This method must be implemented.

setAvailability

void setAvailability(long availability)

Sets the availability.

Parameters:

availability - the new availability

Throws:

InvalidArgumentException - availability is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearAvailability

void clearAvailability()

Clears the availability.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getProductFormRecord

ProductFormRecord getProductFormRecord(Type productRecordType)
                                throws OperationFailedException

Gets the ProductFormRecord corresponding to the given product record Type .

Parameters:

productRecordType - the product record type

Returns:

the product form record

Throws:

NullArgumentException - productRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(productRecordType) is false

Compliance:

mandatory - This method must be implemented.