com.beasys.commerce.ebusiness.order
Interface Order

All Superinterfaces

BusinessSmartComponent, Entity, RemoteRelationalReference, Serializable

public interface Order
extends Entity

An Order entity represents an order. An order includes one or more order lines, order status, shipping address, shipping cost, price, special instructions, splitting preferences, date of order, payment information, and the customer who placed this order.

See Also

OrderPk, OrderHome, OrderValue

Method Summary

boolean	addOrderLines(OrderLine element) Adds an order line to the order
boolean	addOrderLinesCollection(Collection collection) Adds all of the elements in the specified collection to this order
void	clearOrderLinesCollection() Removes all the order lines
boolean	containsOrderLines(OrderLine element) Returns true if the specified order line already exists in this order
boolean	containsOrderLinesCollection(Collection c) Returns true if this order contains all of the order line elements in the specified collection
boolean	equalsOrderLinesCollection(Object object) Compares the specified object with the collection of order lines for equality
Date	getCreatedDate() Returns the date of creation of the order.
Customer	getCustomer() Returns the remote object reference of customer
String	getIdentifier() Returns the primary key identifier.
OrderValue	getOrderByValue() Returns an OrderValue object.
Collection	getOrderLinesCollection() Returns a collection of all order lines
String	getOrderStatus() Returns the order status
PaymentTransaction	getPaymentTransaction() Returns the remote object reference of payment transaction
Money	getPrice() Returns the total price of the order
Money	getShipping() Returns the shipping cost on the order
com.beasys.commerce.axiom.contact.Address	getShippingAddress() Returns the shipping address for the order
String	getShippingMethod() Returns a string identifying the shipping method.
String	getSpecialInstructions() Returns special instructions for the order
String	getSplittingPreference() Returns splitting preferences for the order
double	getSubtotal() Get the value of subtotal
boolean	isOrderLinesCollectionEmpty() Returns true if this order has no order lines
int	orderLinesCollectionHashCode() Returns the hash code value for the collection or order lines
int	orderLinesCollectionSize() Returns the number of elements in this collection
boolean	removeOrderLines(OrderLine element) Removes a single instance of the specified order line element from the collection of order lines, if it is present
boolean	removeOrderLinesCollection(Collection collection) Removes all the order lines that are also contained in the specified collection
boolean	retainOrderLinesCollection(Collection collection) Retains only order lines that are also contained in the specified collection
void	setCreatedDate(Date createdDate) Sets the date of creation of the order
void	setCustomer(Customer customer) Sets the remote object reference of customer
void	setOrderByValue(OrderValue value) Set all of Order's attributes to the passed in value.
void	setOrderLinesCollection(Collection collection) Sets a collection of order lines
void	setOrderStatus(String orderStatus) Sets the status of the order
void	setPaymentTransaction(PaymentTransaction paymentTransaction) Sets the remote object reference of payment transaction
void	setPrice(Money price) Sets the total price of the order
void	setShipping(Money shipping) Sets the cost of shipping for the order
void	setShippingAddress(com.beasys.commerce.axiom.contact.Address shippingAddress) Sets the shipping address for the order
void	setShippingMethod(String shippingMethod) Sets the shipping method
void	setSpecialInstructions(String specialInstructions) Sets special instructions for the order
void	setSplittingPreference(String splittingPreference) Sets splitting preferences for the order
void	setSubtotal(double subtotal) Sets the value of subtotal

Methods inherited from interface com.beasys.commerce.foundation.RemoteRelationalReference

get__classIdentifier, get__containingBelonging, get__containingEntity, get__mapKey, get__sequenceNumber, set__containingBelonging, set__containingEntity, set__mapKey

Method Detail

getOrderByValue

OrderValue getOrderByValue()
                           throws RemoteException

Returns an OrderValue object. The OrderValue object represents the state of an Order.

Returns

OrderValue the Order value object

Throws

RemoteException - on remote error

setOrderByValue

void setOrderByValue(OrderValue value)
                     throws RemoteException

Set all of Order's attributes to the passed in value. Note: Primary key attributes are not set.

Parameters

OrderValue - the OrderValue object

Throws

RemoteException - on remote error

getIdentifier

String getIdentifier()
                     throws RemoteException

Returns the primary key identifier.

Returns

Identifier the primary key

Throws

RemoteException - on remote error

See Also

OrderPk

getCreatedDate

Date getCreatedDate()
                    throws RemoteException

Returns the date of creation of the order.

Returns

createdDate the Date of creation of the order

Throws

RemoteException - on remote error

setCreatedDate

void setCreatedDate(Date createdDate)
                    throws RemoteException

Sets the date of creation of the order

Parameters

createdDate - the date of creation of the order

Throws

RemoteException - on remote error

getShippingMethod

String getShippingMethod()
                         throws RemoteException

Returns a string identifying the shipping method.

Returns

shippingMethod string

Throws

RemoteException - on remote error

See Also

ShippingMethod

setShippingMethod

void setShippingMethod(String shippingMethod)
                       throws RemoteException

Sets the shipping method

Parameters

shippingMethod - shippingMethod to be added

Throws

RemoteException - on remote error

See Also

ShippingMethod

getCustomer

Customer getCustomer()
                     throws RemoteException

Returns the remote object reference of customer

Returns

customer object reference to the customer

Throws

RemoteException - on remote error

See Also

Customer

setCustomer

void setCustomer(Customer customer)
                 throws RemoteException

Sets the remote object reference of customer

Parameters

customer - customer to be added

Throws

RemoteException - on remote error

See Also

Customer

getShippingAddress

com.beasys.commerce.axiom.contact.Address getShippingAddress()
                                                             throws RemoteException

Returns the shipping address for the order

Returns

shippingAddress shipping address.

Throws

RemoteException - on remote error

setShippingAddress

void setShippingAddress(com.beasys.commerce.axiom.contact.Address shippingAddress)
                        throws RemoteException

Sets the shipping address for the order

Parameters

shippingAddress - shippingAddress to be added

Throws

RemoteException - on remote error

getShipping

Money getShipping()
                  throws RemoteException

Returns the shipping cost on the order

Returns

the shipping cost for the order.

Throws

RemoteException - on remote error

setShipping

void setShipping(Money shipping)
                 throws RemoteException

Sets the cost of shipping for the order

Parameters

shipping - the new shipping costs

Throws

RemoteException - on remote error

getPaymentTransaction

PaymentTransaction getPaymentTransaction()
                                         throws RemoteException

Returns the remote object reference of payment transaction

Returns

payment transaction.

Throws

RemoteException - on remote error

See Also

PaymentTransaction

setPaymentTransaction

void setPaymentTransaction(PaymentTransaction paymentTransaction)
                           throws RemoteException

Sets the remote object reference of payment transaction

Parameters

paymentTransaction - payment transaction to be added

Throws

RemoteException - on remote error

See Also

PaymentTransaction

getOrderStatus

String getOrderStatus()
                      throws RemoteException

Returns the order status

Returns

order status.

Throws

RemoteException - on remote error

setOrderStatus

void setOrderStatus(String orderStatus)
                    throws RemoteException

Sets the status of the order

Parameters

orderStatus - order status

Throws

RemoteException - on remote error

getOrderLinesCollection

Collection getOrderLinesCollection()
                                   throws RemoteException

Returns a collection of all order lines

Throws

RemoteException - on remote error

setOrderLinesCollection

void setOrderLinesCollection(Collection collection)
                             throws RemoteException

Sets a collection of order lines

Parameters

collection - of order lines

Throws

RemoteException - on remote error

addOrderLines

boolean addOrderLines(OrderLine element)
                      throws RemoteException

Adds an order line to the order

Parameters

com.beasys.commerce.ebusiness.order.OrderLine - order line

Returns

true if order line could be added successfully

Throws

RemoteException - on remote error

addOrderLinesCollection

boolean addOrderLinesCollection(Collection collection)
                                throws RemoteException

Adds all of the elements in the specified collection to this order

Parameters

collection - of order lines

Throws

RemoteException - on remote error

clearOrderLinesCollection

void clearOrderLinesCollection()
                               throws RemoteException

Removes all the order lines

Throws

RemoteException - on remote error

containsOrderLines

boolean containsOrderLines(OrderLine element)
                           throws RemoteException

Returns true if the specified order line already exists in this order

Parameters

element - order line

Throws

RemoteException - on remote error

containsOrderLinesCollection

boolean containsOrderLinesCollection(Collection c)
                                     throws RemoteException

Returns true if this order contains all of the order line elements in the specified collection

Parameters

c - order lines

Throws

RemoteException - on remote error

equalsOrderLinesCollection

boolean equalsOrderLinesCollection(Object object)
                                   throws RemoteException

Compares the specified object with the collection of order lines for equality

Parameters

object - Object representing a collection of order lines

Throws

RemoteException - on remote error

orderLinesCollectionHashCode

int orderLinesCollectionHashCode()
                                 throws RemoteException

Returns the hash code value for the collection or order lines

Returns

hash code

Throws

RemoteException - on remote error

isOrderLinesCollectionEmpty

boolean isOrderLinesCollectionEmpty()
                                    throws RemoteException

Returns true if this order has no order lines

Throws

RemoteException - on remote error

removeOrderLines

boolean removeOrderLines(OrderLine element)
                         throws RemoteException

Removes a single instance of the specified order line element from the collection of order lines, if it is present

Parameters

element - order line to be removed

Throws

RemoteException - on remote error

removeOrderLinesCollection

boolean removeOrderLinesCollection(Collection collection)
                                   throws RemoteException

Removes all the order lines that are also contained in the specified collection

Parameters

collection - of order lines to be removed

Throws

RemoteException - on remote error

retainOrderLinesCollection

boolean retainOrderLinesCollection(Collection collection)
                                   throws RemoteException

Retains only order lines that are also contained in the specified collection

Parameters

collection - of order lines to be retained

Throws

RemoteException - on remote error

orderLinesCollectionSize

int orderLinesCollectionSize()
                             throws RemoteException

Returns the number of elements in this collection

Returns

Size

Throws

RemoteException - on remote error

getPrice

Money getPrice()
               throws RemoteException

Returns the total price of the order

Returns

the price of the order

Throws

RemoteException - on remote error

setPrice

void setPrice(Money price)
              throws RemoteException

Sets the total price of the order

Parameters

price - the price of the order

Throws

RemoteException - on remote error

setSubtotal

void setSubtotal(double subtotal)
                 throws RemoteException

Sets the value of subtotal

Parameters

subtotal - for the order.

Throws

RemoteException

getSubtotal

double getSubtotal()
                   throws RemoteException

Get the value of subtotal

Returns

the subtotal for the order

Throws

RemoteException

getSpecialInstructions

String getSpecialInstructions()
                              throws RemoteException

Returns special instructions for the order

Returns

special instructions

Throws

RemoteException - on remote error

setSpecialInstructions

void setSpecialInstructions(String specialInstructions)
                            throws RemoteException

Sets special instructions for the order

Parameters

specialInstructions - special instructions for the order

Throws

RemoteException - on remote error

getSplittingPreference

String getSplittingPreference()
                              throws RemoteException

Returns splitting preferences for the order

Returns

splittingPreference splitting preference for the order

Throws

RemoteException - on remote error

setSplittingPreference

void setSplittingPreference(String splittingPreference)
                            throws RemoteException

Sets splitting preferences for the order

Parameters

splittingPreference - splitting preference for the order

Throws

RemoteException - on remote error