org.osid.ordering

Interface OrderForm

All Superinterfaces:

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

All Known Subinterfaces:

OrderBatchForm

public interface OrderForm
extends OsidObjectForm, OsidAggregateableForm

This is the form for creating and updating Order objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the OrderAdminSession. 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	clearCustomer() Clears the customer.
Metadata	getClosedMetadata() Gets the metadata for the closed status.
Metadata	getCustomerMetadata() Gets the metadata for a customer.
OrderFormRecord	getOrderFormRecord(Type orderRecordType) Gets the OrderFormRecord corresponding to the given order record Type.
void	setClosed(boolean closed) Sets the closed status.
void	setCustomer(Id resourceId) Sets the customer.

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

getCustomerMetadata

Metadata getCustomerMetadata()

Gets the metadata for a customer.

Returns:

metadata for the customer

Compliance:

mandatory - This method must be implemented.

setCustomer

void setCustomer(Id resourceId)

Sets the customer.

Parameters:

resourceId - the new address

Throws:

InvalidArgumentException - resourceId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearCustomer

void clearCustomer()

Clears the customer.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getClosedMetadata

Metadata getClosedMetadata()

Gets the metadata for the closed status.

Returns:

metadata for the customer

Compliance:

mandatory - This method must be implemented.

setClosed

void setClosed(boolean closed)

Sets the closed status.

Parameters:

closed - the new closed status

Throws:

InvalidArgumentException - closed is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getOrderFormRecord

OrderFormRecord getOrderFormRecord(Type orderRecordType)
                                   throws OperationFailedException

Gets the OrderFormRecord corresponding to the given order record Type.

Parameters:

orderRecordType - the order record type

Returns:

the order form record

Throws:

NullArgumentException - orderRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(orderRecordType) is false

Compliance:

mandatory - This method must be implemented.