Order Interface

com.beasys.commerce.ebusiness.order
Order Interface

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.

Related Topics

OrderPk
OrderHome
OrderValue

All Superinterfaces
BusinessSmartComponent, EJBObject, Entity, Remote, RemoteRelationalReference, Serializable

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

addOrderLines(OrderLine) Method

public boolean addOrderLines(OrderLine element)
     throws RemoteException
Adds an order line to the order

Parameters

element
order line

Returns

true if order line could be added successfully

Exceptions

RemoteException
on remote error

addOrderLinesCollection(Collection) Method

public boolean addOrderLinesCollection(Collection collection)
     throws RemoteException
Adds all of the elements in the specified collection to this order

Parameters

collection
of order lines

Exceptions

RemoteException
on remote error

clearOrderLinesCollection() Method

public void clearOrderLinesCollection()
     throws RemoteException
Removes all the order lines

Exceptions

RemoteException
on remote error

containsOrderLines(OrderLine) Method

public boolean containsOrderLines(OrderLine element)
     throws RemoteException
Returns true if the specified order line already exists in this order

Parameters

element
order line

Exceptions

RemoteException
on remote error

containsOrderLinesCollection(Collection) Method

public 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

Exceptions

RemoteException
on remote error

equalsOrderLinesCollection(Object) Method

public 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

Exceptions

RemoteException
on remote error

getCreatedDate() Method

public Date getCreatedDate()
     throws RemoteException
Returns the date of creation of the order.

Returns

createdDate the Date of creation of the order

Exceptions

RemoteException
on remote error

getCustomer() Method

public Customer getCustomer()
     throws RemoteException
Returns the remote object reference of customer

Returns

customer object reference to the customer

Exceptions

RemoteException
on remote error

Related Topics

Customer

getIdentifier() Method

public String getIdentifier()
     throws RemoteException
Returns the primary key identifier.

Returns

Identifier the primary key

Exceptions

RemoteException
on remote error

Related Topics

OrderPk

getOrderByValue() Method

public OrderValue getOrderByValue()
     throws RemoteException
Returns an OrderValue object. The OrderValue object represents the state of an Order.

Returns

OrderValue the Order value object

Exceptions

RemoteException
on remote error

getOrderLinesCollection() Method

public Collection getOrderLinesCollection()
     throws RemoteException
Returns a collection of all order lines

Exceptions

RemoteException
on remote error

getOrderStatus() Method

public String getOrderStatus()
     throws RemoteException
Returns the order status

Returns

order status.

Exceptions

RemoteException
on remote error

getPaymentTransaction() Method

public PaymentTransaction getPaymentTransaction()
     throws RemoteException
Returns the remote object reference of payment transaction

Returns

payment transaction.

Exceptions

RemoteException
on remote error

Related Topics

PaymentTransaction

getPrice() Method

public Money getPrice()
     throws RemoteException
Returns the total price of the order

Returns

the price of the order

Exceptions

RemoteException
on remote error

getShipping() Method

public Money getShipping()
     throws RemoteException
Returns the shipping cost on the order

Returns

the shipping cost for the order.

Exceptions

RemoteException
on remote error

getShippingAddress() Method

public Address getShippingAddress()
     throws RemoteException
Returns the shipping address for the order

Returns

shippingAddress shipping address.

Exceptions

RemoteException
on remote error

getShippingMethod() Method

public String getShippingMethod()
     throws RemoteException
Returns a string identifying the shipping method.

Returns

shippingMethod string

Exceptions

RemoteException
on remote error

Related Topics

ShippingMethod

getSpecialInstructions() Method

public String getSpecialInstructions()
     throws RemoteException
Returns special instructions for the order

Returns

special instructions

Exceptions

RemoteException
on remote error

getSplittingPreference() Method

public String getSplittingPreference()
     throws RemoteException
Returns splitting preferences for the order

Returns

splittingPreference splitting preference for the order

Exceptions

RemoteException
on remote error

getSubtotal() Method

public double getSubtotal()
     throws RemoteException
Get the value of subtotal

Returns

the subtotal for the order

Exceptions

RemoteException

isOrderLinesCollectionEmpty() Method

public boolean isOrderLinesCollectionEmpty()
     throws RemoteException
Returns true if this order has no order lines

Exceptions

RemoteException
on remote error

orderLinesCollectionHashCode() Method

public int orderLinesCollectionHashCode()
     throws RemoteException
Returns the hash code value for the collection or order lines

Returns

hash code

Exceptions

RemoteException
on remote error

orderLinesCollectionSize() Method

public int orderLinesCollectionSize()
     throws RemoteException
Returns the number of elements in this collection

Returns

Size

Exceptions

RemoteException
on remote error

removeOrderLines(OrderLine) Method

public 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

Exceptions

RemoteException
on remote error

removeOrderLinesCollection(Collection) Method

public 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

Exceptions

RemoteException
on remote error

retainOrderLinesCollection(Collection) Method

public 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

Exceptions

RemoteException
on remote error

setCreatedDate(Date) Method

public void setCreatedDate(Date createdDate)
     throws RemoteException
Sets the date of creation of the order

Parameters

createdDate
the date of creation of the order

Exceptions

RemoteException
on remote error

setCustomer(Customer) Method

public void setCustomer(Customer customer)
     throws RemoteException
Sets the remote object reference of customer

Parameters

customer
customer to be added

Exceptions

RemoteException
on remote error

Related Topics

Customer

setOrderByValue(OrderValue) Method

public 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

value
the OrderValue object

Exceptions

RemoteException
on remote error

setOrderLinesCollection(Collection) Method

public void setOrderLinesCollection(Collection collection)
     throws RemoteException
Sets a collection of order lines

Parameters

collection
of order lines

Exceptions

RemoteException
on remote error

setOrderStatus(String) Method

public void setOrderStatus(String orderStatus)
     throws RemoteException
Sets the status of the order

Parameters

orderStatus
order status

Exceptions

RemoteException
on remote error

setPaymentTransaction(PaymentTransaction) Method

public void setPaymentTransaction(PaymentTransaction paymentTransaction)
     throws RemoteException
Sets the remote object reference of payment transaction

Parameters

paymentTransaction
payment transaction to be added

Exceptions

RemoteException
on remote error

Related Topics

PaymentTransaction

setPrice(Money) Method

public void setPrice(Money price)
     throws RemoteException
Sets the total price of the order

Parameters

price
the price of the order

Exceptions

RemoteException
on remote error

setShipping(Money) Method

public void setShipping(Money shipping)
     throws RemoteException
Sets the cost of shipping for the order

Parameters

shipping
the new shipping costs

Exceptions

RemoteException
on remote error

setShippingAddress(Address) Method

public void setShippingAddress(Address shippingAddress)
     throws RemoteException
Sets the shipping address for the order

Parameters

shippingAddress
shippingAddress to be added

Exceptions

RemoteException
on remote error

setShippingMethod(String) Method

public void setShippingMethod(String shippingMethod)
     throws RemoteException
Sets the shipping method

Parameters

shippingMethod
shippingMethod to be added

Exceptions

RemoteException
on remote error

Related Topics

ShippingMethod

setSpecialInstructions(String) Method

public void setSpecialInstructions(String specialInstructions)
     throws RemoteException
Sets special instructions for the order

Parameters

specialInstructions
special instructions for the order

Exceptions

RemoteException
on remote error

setSplittingPreference(String) Method

public void setSplittingPreference(String splittingPreference)
     throws RemoteException
Sets splitting preferences for the order

Parameters

splittingPreference
splitting preference for the order

Exceptions

RemoteException
on remote error

setSubtotal(double) Method

public void setSubtotal(double subtotal)
     throws RemoteException
Sets the value of subtotal

Parameters

subtotal
for the order.

Exceptions

RemoteException