org.osid.bidding.batch

Interface BidBatchForm

All Superinterfaces:

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

public interface BidBatchForm
extends BidForm

This is the form for creating and updating bids in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BidBatchAdminSession. 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
Id	getAuctionId() Gets the Auction Id of the bid if this is a create transaction.
Id	getBidId() Gets the Id of the bid to be updated if this is an update transaction.
Id	getResourceId() Gets the Resource Id of the bid if this is a create transaction.

Methods inherited from interface org.osid.bidding.BidForm

clearMaximumBid, clearQuantity, getBidFormRecord, getMaximumBidMetadata, getQuantityMetadata, setMaximumBid, setQuantity

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

getAuctionId

Id getAuctionId()

Gets the Auction Id of the bid if this is a create transaction.

Returns:

the auction Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getResourceId

Id getResourceId()

Gets the Resource Id of the bid if this is a create transaction.

Returns:

the resource Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getBidId

Id getBidId()

Gets the Id of the bid to be updated if this is an update transaction.

Returns:

the bid Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.