org.osid.bidding.rules

Interface AuctionConstrainerForm

All Superinterfaces:

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

public interface AuctionConstrainerForm
extends OsidConstrainerForm

This is the form for creating and updating AuctionConstrainers. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AuctionConstrainerAdminSession. 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
AuctionConstrainerFormRecord	getAuctionConstrainerFormRecord(Type auctionConstrainerRecordType) Gets the AuctionConstrainerFormRecord corresponding to the given auction constrainer 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

getAuctionConstrainerFormRecord

AuctionConstrainerFormRecord getAuctionConstrainerFormRecord(Type auctionConstrainerRecordType)
                                                             throws OperationFailedException

Gets the AuctionConstrainerFormRecord corresponding to the given auction constrainer record Type.

Parameters:

auctionConstrainerRecordType - an auction constrainer record type

Returns:

the auction constrainer form record

Throws:

NullArgumentException - auctionConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.