org.osid.ordering

Interface PriceScheduleForm

All Superinterfaces:

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

All Known Subinterfaces:

PriceBatchForm, PriceScheduleBatchForm

public interface PriceScheduleForm
extends OsidObjectForm, OsidAggregateableForm

This is the form for creating and updating PriceSchedules. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the PriceScheduleAdminSession. 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
PriceScheduleFormRecord	getPriceScheduleFormRecord(Type priceScheduleRecordType) Gets the PriceScheduleFormRecord corresponding to the given price schedule record Type.

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

Method Detail

getPriceScheduleFormRecord

PriceScheduleFormRecord getPriceScheduleFormRecord(Type priceScheduleRecordType)
                                                   throws OperationFailedException

Gets the PriceScheduleFormRecord corresponding to the given price schedule record Type.

Parameters:

priceScheduleRecordType - the price schedule record type

Returns:

the price schedule form record

Throws:

NullArgumentException - priceScheduleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(priceScheduleRecordType) is false

Compliance:

mandatory - This method must be implemented.