com.beasys.commerce.ebusiness.order
Interface Order

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(java.util.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(java.util.Collection c) Returns true if this order contains all of the order line elements in the specified collection
boolean	equalsOrderLinesCollection(java.lang.Object object) Compares the specified object with the collection of order lines for equality
java.sql.Date	getCreatedDate() Returns the date of creation of the order.
Customer	getCustomer() Returns the remote object reference of customer
java.lang.String	getIdentifier() Returns the primary key identifier.
OrderValue	getOrderByValue() Returns an OrderValue object.
java.util.Collection	getOrderLinesCollection() Returns a collection of all order lines
java.lang.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
java.lang.String	getShippingMethod() Returns a string identifying the shipping method.
java.lang.String	getSpecialInstructions() Returns special instructions for the order
java.lang.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(java.util.Collection collection) Removes all the order lines that are also contained in the specified collection
boolean	retainOrderLinesCollection(java.util.Collection collection) Retains only order lines that are also contained in the specified collection
void	setCreatedDate(java.sql.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(java.util.Collection collection) Sets a collection of order lines
void	setOrderStatus(java.lang.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(java.lang.String shippingMethod) Sets the shipping method
void	setSpecialInstructions(java.lang.String specialInstructions) Sets special instructions for the order
void	setSplittingPreference(java.lang.String splittingPreference) Sets splitting preferences for the order
void	setSubtotal(double subtotal) Sets the value of subtotal

Methods inherited from interface javax.ejb.EJBObject

getEJBHome, getHandle, getPrimaryKey, isIdentical, remove

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

public OrderValue getOrderByValue()
                           throws java.rmi.RemoteException

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

Returns:

OrderValue the Order value object

Throws:

java.rmi.RemoteException - on remote error

setOrderByValue

public void setOrderByValue(OrderValue value)
                     throws java.rmi.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:

java.rmi.RemoteException - on remote error

getIdentifier

public java.lang.String getIdentifier()
                               throws java.rmi.RemoteException

Returns the primary key identifier.

Returns:

Identifier the primary key

Throws:

java.rmi.RemoteException - on remote error

See Also:

OrderPk

getCreatedDate

public java.sql.Date getCreatedDate()
                             throws java.rmi.RemoteException

Returns the date of creation of the order.

Returns:

createdDate the Date of creation of the order

Throws:

java.rmi.RemoteException - on remote error

setCreatedDate

public void setCreatedDate(java.sql.Date createdDate)
                    throws java.rmi.RemoteException

Sets the date of creation of the order

Parameters:

createdDate - the date of creation of the order

Throws:

java.rmi.RemoteException - on remote error

getShippingMethod

public java.lang.String getShippingMethod()
                                   throws java.rmi.RemoteException

Returns a string identifying the shipping method.

Returns:

shippingMethod string

Throws:

java.rmi.RemoteException - on remote error

See Also:

ShippingMethod

setShippingMethod

public void setShippingMethod(java.lang.String shippingMethod)
                       throws java.rmi.RemoteException

Sets the shipping method

Parameters:

shippingMethod - shippingMethod to be added

Throws:

java.rmi.RemoteException - on remote error

See Also:

ShippingMethod

getCustomer

public Customer getCustomer()
                     throws java.rmi.RemoteException

Returns the remote object reference of customer

Returns:

customer object reference to the customer

Throws:

java.rmi.RemoteException - on remote error

See Also:

Customer

setCustomer

public void setCustomer(Customer customer)
                 throws java.rmi.RemoteException

Sets the remote object reference of customer

Parameters:

customer - customer to be added

Throws:

java.rmi.RemoteException - on remote error

See Also:

Customer

getShippingAddress

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

Returns the shipping address for the order

Returns:

shippingAddress shipping address.

Throws:

java.rmi.RemoteException - on remote error

setShippingAddress

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

Sets the shipping address for the order

Parameters:

shippingAddress - shippingAddress to be added

Throws:

java.rmi.RemoteException - on remote error

getShipping

public Money getShipping()
                  throws java.rmi.RemoteException

Returns the shipping cost on the order

Returns:

the shipping cost for the order.

Throws:

java.rmi.RemoteException - on remote error

setShipping

public void setShipping(Money shipping)
                 throws java.rmi.RemoteException

Sets the cost of shipping for the order

Parameters:

shipping - the new shipping costs

Throws:

java.rmi.RemoteException - on remote error

getPaymentTransaction

public PaymentTransaction getPaymentTransaction()
                                         throws java.rmi.RemoteException

Returns the remote object reference of payment transaction

Returns:

payment transaction.

Throws:

java.rmi.RemoteException - on remote error

See Also:

PaymentTransaction

setPaymentTransaction

public void setPaymentTransaction(PaymentTransaction paymentTransaction)
                           throws java.rmi.RemoteException

Sets the remote object reference of payment transaction

Parameters:

paymentTransaction - payment transaction to be added

Throws:

java.rmi.RemoteException - on remote error

See Also:

PaymentTransaction

getOrderStatus

public java.lang.String getOrderStatus()
                                throws java.rmi.RemoteException

Returns the order status

Returns:

order status.

Throws:

java.rmi.RemoteException - on remote error

setOrderStatus

public void setOrderStatus(java.lang.String orderStatus)
                    throws java.rmi.RemoteException

Sets the status of the order

Parameters:

orderStatus - order status

Throws:

java.rmi.RemoteException - on remote error

getOrderLinesCollection

public java.util.Collection getOrderLinesCollection()
                                             throws java.rmi.RemoteException

Returns a collection of all order lines

Throws:

java.rmi.RemoteException - on remote error

setOrderLinesCollection

public void setOrderLinesCollection(java.util.Collection collection)
                             throws java.rmi.RemoteException

Sets a collection of order lines

Parameters:

collection - of order lines

Throws:

java.rmi.RemoteException - on remote error

addOrderLines

public boolean addOrderLines(OrderLine element)
                      throws java.rmi.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

addOrderLinesCollection

public boolean addOrderLinesCollection(java.util.Collection collection)
                                throws java.rmi.RemoteException

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

Parameters:

collection - of order lines

Throws:

java.rmi.RemoteException - on remote error

clearOrderLinesCollection

public void clearOrderLinesCollection()
                               throws java.rmi.RemoteException

Removes all the order lines

Throws:

java.rmi.RemoteException - on remote error

containsOrderLines

public boolean containsOrderLines(OrderLine element)
                           throws java.rmi.RemoteException

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

Parameters:

element - order line

Throws:

java.rmi.RemoteException - on remote error

containsOrderLinesCollection

public boolean containsOrderLinesCollection(java.util.Collection c)
                                     throws java.rmi.RemoteException

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

Parameters:

c - order lines

Throws:

java.rmi.RemoteException - on remote error

equalsOrderLinesCollection

public boolean equalsOrderLinesCollection(java.lang.Object object)
                                   throws java.rmi.RemoteException

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

Parameters:

object - Object representing a collection of order lines

Throws:

java.rmi.RemoteException - on remote error

orderLinesCollectionHashCode

public int orderLinesCollectionHashCode()
                                 throws java.rmi.RemoteException

Returns the hash code value for the collection or order lines

Returns:

hash code

Throws:

java.rmi.RemoteException - on remote error

isOrderLinesCollectionEmpty

public boolean isOrderLinesCollectionEmpty()
                                    throws java.rmi.RemoteException

Returns true if this order has no order lines

Throws:

java.rmi.RemoteException - on remote error

removeOrderLines

public boolean removeOrderLines(OrderLine element)
                         throws java.rmi.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:

java.rmi.RemoteException - on remote error

removeOrderLinesCollection

public boolean removeOrderLinesCollection(java.util.Collection collection)
                                   throws java.rmi.RemoteException

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

Parameters:

collection - of order lines to be removed

Throws:

java.rmi.RemoteException - on remote error

retainOrderLinesCollection

public boolean retainOrderLinesCollection(java.util.Collection collection)
                                   throws java.rmi.RemoteException

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

Parameters:

collection - of order lines to be retained

Throws:

java.rmi.RemoteException - on remote error

orderLinesCollectionSize

public int orderLinesCollectionSize()
                             throws java.rmi.RemoteException

Returns the number of elements in this collection

Returns:

Size

Throws:

java.rmi.RemoteException - on remote error

getPrice

public Money getPrice()
               throws java.rmi.RemoteException

Returns the total price of the order

Returns:

the price of the order

Throws:

java.rmi.RemoteException - on remote error

setPrice

public void setPrice(Money price)
              throws java.rmi.RemoteException

Sets the total price of the order

Parameters:

price - the price of the order

Throws:

java.rmi.RemoteException - on remote error

setSubtotal

public void setSubtotal(double subtotal)
                 throws java.rmi.RemoteException

Sets the value of subtotal

Parameters:

subtotal - for the order.

getSubtotal

public double getSubtotal()
                   throws java.rmi.RemoteException

Get the value of subtotal

Returns:

the subtotal for the order

getSpecialInstructions

public java.lang.String getSpecialInstructions()
                                        throws java.rmi.RemoteException

Returns special instructions for the order

Returns:

special instructions

Throws:

java.rmi.RemoteException - on remote error

setSpecialInstructions

public void setSpecialInstructions(java.lang.String specialInstructions)
                            throws java.rmi.RemoteException

Sets special instructions for the order

Parameters:

specialInstructions - special instructions for the order

Throws:

java.rmi.RemoteException - on remote error

getSplittingPreference

public java.lang.String getSplittingPreference()
                                        throws java.rmi.RemoteException

Returns splitting preferences for the order

Returns:

splittingPreference splitting preference for the order

Throws:

java.rmi.RemoteException - on remote error

setSplittingPreference

public void setSplittingPreference(java.lang.String splittingPreference)
                            throws java.rmi.RemoteException

Sets splitting preferences for the order

Parameters:

splittingPreference - splitting preference for the order

Throws:

java.rmi.RemoteException - on remote error