org.osid.bidding.rules

Interface AuctionProcessorForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidProcessorForm, OsidRuleForm, Suppliable

public interface AuctionProcessorForm
extends OsidProcessorForm

This is the form for creating and updating AuctionProcessors. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AuctionProcessorAdminSession. 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
AuctionProcessorFormRecord	getAuctionProcessorFormRecord(Type auctionProcessorRecordType) Gets the AuctionProcessorFormRecord corresponding to the given auction processor record Type.

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

getAuctionProcessorFormRecord

AuctionProcessorFormRecord getAuctionProcessorFormRecord(Type auctionProcessorRecordType)
                                                         throws OperationFailedException

Gets the AuctionProcessorFormRecord corresponding to the given auction processor record Type.

Parameters:

auctionProcessorRecordType - an auction processor record type

Returns:

the auction processor form record

Throws:

NullArgumentException - auctionProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.