org.osid.bidding

Interface BidForm

All Superinterfaces:

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

All Known Subinterfaces:

BidBatchForm

public interface BidForm
extends OsidRelationshipForm

This is the form for creating and updating Bids. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BidAdminSession. 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	clearMaximumBid() Removes the maximum bid.
void	clearQuantity() Removes the quantity.
BidFormRecord	getBidFormRecord(Type bidRecordType) Gets the BidFormRecord corresponding to the given bid record Type.
Metadata	getMaximumBidMetadata() Gets the metadata for the maximum bid.
Metadata	getQuantityMetadata() Gets the metadata for the quantity.
void	setMaximumBid(Currency bid) Sets the maximum bid.
void	setQuantity(long quantity) Sets the quantity.

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.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getQuantityMetadata

Metadata getQuantityMetadata()

Gets the metadata for the quantity.

Returns:

metadata for the quantity

Compliance:

mandatory - This method must be implemented.

setQuantity

void setQuantity(long quantity)

Sets the quantity.

Parameters:

quantity - the new quantity

Throws:

InvalidArgumentException - quantity is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearQuantity

void clearQuantity()

Removes the quantity.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getMaximumBidMetadata

Metadata getMaximumBidMetadata()

Gets the metadata for the maximum bid.

Returns:

metadata for the maximum bid

Compliance:

mandatory - This method must be implemented.

setMaximumBid

void setMaximumBid(Currency bid)

Sets the maximum bid.

Parameters:

bid - the new maximum bid

Throws:

InvalidArgumentException - bid is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - bid is null

Compliance:

mandatory - This method must be implemented.

clearMaximumBid

void clearMaximumBid()

Removes the maximum bid.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getBidFormRecord

BidFormRecord getBidFormRecord(Type bidRecordType)
                               throws OperationFailedException

Gets the BidFormRecord corresponding to the given bid record Type.

Parameters:

bidRecordType - a bid record type

Returns:

the bid form record

Throws:

NullArgumentException - bidRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(bidRecordType) is false

Compliance:

mandatory - This method must be implemented.