# com.beasys.commerce.ebusiness.order
OrderImpl Class

public class OrderImpl
extends `EntityImpl`

This is a class that will implement the business process of order fulfillment.

     Primary Key = OrderPk

Related Topics

``Order``
``OrderHome``
``OrderValue``

Hierarchy
  `Object`
  `EntityImpl`
  `OrderImpl`

All Implemented Interfaces
  `EnterpriseBean`, `EntityBean`, `RelationalReference`, `Serializable`

## Field Summary

`public `Date`` | `createdDate` Containment: By Value Multiplicity: 1:1
`public `SmartEntityReference`` | `customer` Order has a reference to the Customer that committed it Containment: By Reference Multiplicity: 1:1
`public `String`` | `identifier` Containment: By Value Multiplicity: 1:1 PRIMARY KEY FIELD
`public `SmartCollectionReference`` | `orderLines` Containment: By Value Multiplicity: 0:N Interface: java.util.Collection
`public `String`` | `orderStatus` Containment: By Value Multiplicity: 1:1
`public `SmartEntityReference`` | `paymentTransaction` Containment: By Reference Multiplicity: 1:1
`public `Money`` | `price` Containment: By Value Multiplicity: 1:1
`public `Money`` | `shipping` Containment: By Value Multiplicity: 1:1
`public `Address`` | `shippingAddress` Containment: By Value Multiplicity: 1:1
`public `String`` | `shippingMethod` Containment: By Value Multiplicity: 1:1
`public `String`` | `specialInstructions` Containment: By Value Multiplicity: 1:1
`public `String`` | `splittingPreference` Containment: By Value Multiplicity: 1:1
`public double` | `subtotal` The subtotal for the order

Fields from com.beasys.commerce.foundation`.`EntityImpl``
``__classIdentifier`, `__containingEntity`, `__mapKey`, `__sequenceNumber`, `_ctx`, `_environmentNamingContext`, `_environmentPropertyCache`, `_isDirty`, `_smartBMP``

## Constructor Summary

OrderImpl()

## Method Summary

`public boolean` | `addOrderLines`(`OrderLine` element) Ensures that this collection contains the specified element (optional operation).
`public boolean` | `addOrderLinesCollection`(`Collection` collection) Adds all of the elements in the specified collection to this collection (optional operation).
`protected void` | `bscInitializeAttributes`(`OrderPk` orderPk)
`public void` | `clearOrderLinesCollection`() Removes all of the elements from this collection (optional operation).
`public boolean` | `containsOrderLines`(`OrderLine` element) Returns true if this collection contains the specified element.
`public boolean` | `containsOrderLinesCollection`(`Collection` collection) Returns true if this collection contains all of the elements in the specified collection.
`public void` | `ejbActivate`() ejbActivate method.
`public `OrderPk`` | `ejbCreate`(`OrderPk` orderPk)
`public `Collection`` | `ejbFindByCustomer`(`String` customerIdentifier) Returns a list of Orders in the system that are associated with the specified Customer identifier.
`public `Collection`` | `ejbFindByDate`(`Date` from, `Date` to) Returns a list of Orders in the system that fall within the given date range.
`public `OrderPk`` | `ejbFindByPrimaryKey`(`OrderPk` pk)
`public `Collection`` | `ejbFindByStatus`(`String` findStatus) Returns an enumeration of all the Orders in the system with the specified status.
`public void` | `ejbLoad`() ejbLoad method.
`public void` | `ejbPassivate`() ejbPassivate method.
`public void` | `ejbPostCreate`(`OrderPk` orderPk)
`public void` | `ejbRemove`() ejbRemove method.
`public void` | `ejbStore`() ejbStore method.
`public boolean` | `equalsOrderLinesCollection`(`Object` object) Compares the specified object with this collection for equality.
`public `Date`` | `getCreatedDate`() Get the value of createdDate
`public `Customer`` | `getCustomer`() Get the remote object reference of customer
`public `SmartEntityReference`` | `getCustomerReference`() Get the SmartEntityReference for customer
`public `String`` | `getIdentifier`()
`public `OrderValue`` | `getOrderByValue`() Get all of Order's attributes.
`public `Collection`` | `getOrderLinesCollection`() Returns a deep copy of the entire collection
`public `SmartCollectionReference`` | `getOrderLinesCollectionReference`() Get the SmartCollectionReference for orderLines
`public `String`` | `getOrderStatus`() Get the value of orderStatus
`public `PaymentTransaction`` | `getPaymentTransaction`() Get the remote object reference of paymentTransaction
`public `SmartEntityReference`` | `getPaymentTransactionReference`() Get the SmartEntityReference for paymentTransaction
`public `Money`` | `getPrice`() Get the value of price
`public `Money`` | `getShipping`() Get the value of shipping
`public `Address`` | `getShippingAddress`() Get the value of shippingAddress
`public `String`` | `getShippingMethod`() Get the value of shippingMethod
`public `String`` | `getSpecialInstructions`() Get the value of specialInstructions
`public `String`` | `getSplittingPreference`() Get the value of splittingPreference
`public double` | `getSubtotal`() Get the value of subtotal
`public `Money`` | `getTotal`(int totalType) Gets the shopping cart total for the given total type
`public boolean` | `isOrderLinesCollectionEmpty`() Returns true if this collection contains no elements.
`public int` | `orderLinesCollectionHashCode`() Returns the hash code value for this collection.
`public `Iterator`` | `orderLinesCollectionIterator`() Returns an iterator over the elements in this collection.
`public int` | `orderLinesCollectionSize`() Returns the number of elements in this collection.
`public boolean` | `removeOrderLines`(`OrderLine` element) Removes a single instance of the specified element from this collection, if it is present (optional operation).
`public boolean` | `removeOrderLinesCollection`(`Collection` collection) Removes all this collection's elements that are also contained in the specified collection (optional operation).
`public boolean` | `retainOrderLinesCollection`(`Collection` collection) Retains only the elements in this collection that are contained in the specified collection (optional operation).
`public void` | `setCreatedDate`(`Date` createdDate) Set the value of createdDate
`public void` | `setCustomer`(`Customer` customer) Set the remote object reference of customer
`public void` | `setCustomerReference`(`SmartEntityReference` smartEntityReference) Set the SmartEntityReference for customer
`public void` | `setEntityContext`(`EntityContext` ctx) setEntityContext method.
`public void` | `setIdentifier`(`String` value)
`public void` | `setOrderByValue`(`OrderValue` value) Set all of Order's attributes to the passed in value.
`public void` | `setOrderLinesCollection`(`Collection` collection) Sets the entire collection
`public void` | `setOrderLinesCollectionReference`(`SmartCollectionReference` smartCollectionReference) Set the SmartCollectionReference for orderLines
`public void` | `setOrderStatus`(`String` orderStatus) Set the value of orderStatus
`public void` | `setPaymentTransaction`(`PaymentTransaction` paymentTransaction) Set the remote object reference of paymentTransaction
`public void` | `setPaymentTransactionReference`(`SmartEntityReference` smartEntityReference) Set the SmartEntityReference for paymentTransaction
`public void` | `setPrice`(`Money` price) Set the value of price
`public void` | `setShipping`(`Money` shipping) Set the value of shipping
`public void` | `setShippingAddress`(`Address` shippingAddress) Set the value of shippingAddress
`public void` | `setShippingMethod`(`String` shippingMethod) Set the value of shippingMethod
`public void` | `setSpecialInstructions`(`String` specialInstructions) Set the value of specialInstructions
`public void` | `setSplittingPreference`(`String` splittingPreference) Set the value of splittingPreference
`public void` | `setSubtotal`(double subtotal) Sets the value of subtotal
`public void` | `unsetEntityContext`() unsetEntityContext method.

Methods from `com.beasys.commerce.foundation.`EntityImpl``
``bscInitializeAttributes`, `clearRelationalBinding`, `clearRelationalBinding`, `clearRelationalBinding`, `clearRelationalBinding`, `doRelationalBinding`, `doRelationalBinding`, `doRelationalBindingOnElement`, `doRelationalBindingOnElement`, `doRelationalBindingOnElement`, `doRelationalBindingOnSingleton`, `doRelationalBindingOnSingleton`, `doRelationalBindingOnSingleton`, `doRelationalBindingWithMapKey`, `doRelationalBindingWithMapKey`, `doRelationalBindingWithMapKey`, `ejbCreate`, `ejbFindAll`, `ejbFindByPrimaryKey`, `ejbPostCreate`, `enumerateRelationalBinding`, `enumerateRelationalBinding`, `get__classIdentifier`, `get__containingBelonging`, `get__containingEntity`, `get__containingEntityReference`, `get__mapKey`, `get__sequenceNumber`, `getEntityContext`, `getEnvironmentNamingContext`, `getEnvironmentProperty`, `getEnvironmentProperty`, `getEnvironmentPropertyCache`, `getPersistenceHelperPlugin`, `getSmartBMP`, `initSmartBMP`, `isModified`, `set__classIdentifier`, `set__containingBelonging`, `set__containingEntity`, `set__containingEntityReference`, `set__mapKey`,`

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods from interface `javax.ejb.`EntityBean``
`ejbActivate, ejbLoad, ejbPassivate, ejbRemove, ejbStore, setEntityContext, unsetEntityContext`

Methods from interface `com.beasys.commerce.foundation.`RelationalReference``
``get__classIdentifier`, `get__containingBelonging`, `get__containingEntity`, `get__mapKey`, `get__sequenceNumber`, `set__containingBelonging`, `set__containingEntity`, `set__mapKey``

## Field Detail

### createdDate

    public Date createdDate

  - Containment: By Value
  - Multiplicity: 1:1

### customer

    public SmartEntityReference customer

  Order has a reference to the Customer that committed it
  - Containment: By Reference
  - Multiplicity: 1:1

### identifier

    public String identifier

  - Containment: By Value
  - Multiplicity: 1:1
  - PRIMARY KEY FIELD

### orderLines

    public SmartCollectionReference orderLines

  - Containment: By Value
  - Multiplicity: 0:N
  - Interface: java.util.Collection

### orderStatus

    public String orderStatus

  - Containment: By Value
  - Multiplicity: 1:1

### paymentTransaction

    public SmartEntityReference paymentTransaction

  - Containment: By Reference
  - Multiplicity: 1:1

### price

    public Money price

  - Containment: By Value
  - Multiplicity: 1:1

### shipping

    public Money shipping

  - Containment: By Value
  - Multiplicity: 1:1

### shippingAddress

    public Address shippingAddress

  - Containment: By Value
  - Multiplicity: 1:1

### shippingMethod

    public String shippingMethod

  - Containment: By Value
  - Multiplicity: 1:1

### specialInstructions

    public String specialInstructions

  - Containment: By Value
  - Multiplicity: 1:1

### splittingPreference

    public String splittingPreference

  - Containment: By Value
  - Multiplicity: 1:1

### subtotal

    public double subtotal

  The subtotal for the order

## Constructor Detail

### OrderImpl

    public OrderImpl()

## Method Detail

### addOrderLines(OrderLine) Method

    public boolean addOrderLines(OrderLine element)

Ensures that this collection contains the specified element (optional operation).

### addOrderLinesCollection(Collection) Method

    public boolean addOrderLinesCollection(Collection collection)

Adds all of the elements in the specified collection to this collection (optional operation).

### bscInitializeAttributes(OrderPk) Method

    protected void bscInitializeAttributes(OrderPk orderPk)
         throws CreateException

#### Exceptions

``CreateException``

### clearOrderLinesCollection() Method

    public void clearOrderLinesCollection()

Removes all of the elements from this collection (optional operation).

### containsOrderLines(OrderLine) Method

    public boolean containsOrderLines(OrderLine element)

Returns true if this collection contains the specified element.

### containsOrderLinesCollection(Collection) Method

    public boolean containsOrderLinesCollection(Collection collection)

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

### ejbActivate() Method

    public void ejbActivate()
         throws EJBException

Description copied from `EntityImpl.ejbActivate()`
ejbActivate method.

Overrides
  `EntityImpl.ejbActivate()`

#### Exceptions

``EJBException``

### ejbCreate(OrderPk) Method

    public OrderPk ejbCreate(OrderPk orderPk)
         throws CreateException

#### Exceptions

``CreateException``

### ejbFindByCustomer(String) Method

    public Collection ejbFindByCustomer(String customerIdentifier)
         throws FinderException

Returns a list of Orders in the system that are associated with the specified Customer identifier.

#### Exceptions

``FinderException``

### ejbFindByDate(Date, Date) Method

    public Collection ejbFindByDate(Date from,
                                    Date to)
         throws FinderException

Returns a list of Orders in the system that fall within the given date range.

#### Exceptions

``FinderException``

### ejbFindByPrimaryKey(OrderPk) Method

    public OrderPk ejbFindByPrimaryKey(OrderPk pk)
         throws FinderException

#### Exceptions

``FinderException``

### ejbFindByStatus(String) Method

    public Collection ejbFindByStatus(String findStatus)
         throws FinderException

Returns an enumeration of all the Orders in the system with the specified status.

#### Exceptions

``FinderException``

### ejbLoad() Method

    public void ejbLoad()
         throws EJBException

Description copied from `EntityImpl.ejbLoad()`
ejbLoad method.

Overrides
  `EntityImpl.ejbLoad()`

#### Exceptions

``EJBException``

### ejbPassivate() Method

    public void ejbPassivate()
         throws EJBException

Description copied from `EntityImpl.ejbPassivate()`
ejbPassivate method.

Overrides
  `EntityImpl.ejbPassivate()`

#### Exceptions

``EJBException``

### ejbPostCreate(OrderPk) Method

    public void ejbPostCreate(OrderPk orderPk)
         throws CreateException

#### Exceptions

``CreateException``

### ejbRemove() Method

    public void ejbRemove()
         throws RemoveException

Description copied from `EntityImpl.ejbRemove()`
ejbRemove method.

Overrides
  `EntityImpl.ejbRemove()`

#### Exceptions

``RemoveException``

### ejbStore() Method

    public void ejbStore()
         throws EJBException

Description copied from `EntityImpl.ejbStore()`
ejbStore method.

Overrides
  `EntityImpl.ejbStore()`

#### Exceptions

``EJBException``

### equalsOrderLinesCollection(Object) Method

    public boolean equalsOrderLinesCollection(Object object)

Compares the specified object with this collection for equality.

### getCreatedDate() Method

    public Date getCreatedDate()

Get the value of createdDate

#### Returns

createdDate.

### getCustomer() Method

    public Customer getCustomer()

Get the remote object reference of customer

#### Returns

customer.

### getCustomerReference() Method

    public SmartEntityReference getCustomerReference()

Get the SmartEntityReference for customer

### getIdentifier() Method

    public String getIdentifier()

### getOrderByValue() Method

    public OrderValue getOrderByValue()
         throws RemoteException

Get all of Order's attributes.

#### Returns

OrderValue the Order value object

#### Exceptions

``RemoteException``

### getOrderLinesCollection() Method

    public Collection getOrderLinesCollection()

Returns a deep copy of the entire collection

### getOrderLinesCollectionReference() Method

    public SmartCollectionReference getOrderLinesCollectionReference()

Get the SmartCollectionReference for orderLines

### getOrderStatus() Method

    public String getOrderStatus()

Get the value of orderStatus

#### Returns

orderStatus.

### getPaymentTransaction() Method

    public PaymentTransaction getPaymentTransaction()

Get the remote object reference of paymentTransaction

#### Returns

paymentTransaction.

### getPaymentTransactionReference() Method

    public SmartEntityReference getPaymentTransactionReference()

Get the SmartEntityReference for paymentTransaction

### getPrice() Method

    public Money getPrice()

Get the value of price

#### Returns

price.

### getShipping() Method

    public Money getShipping()

Get the value of shipping

#### Returns

shipping.

### getShippingAddress() Method

    public Address getShippingAddress()

Get the value of shippingAddress

#### Returns

shippingAddress.

### getShippingMethod() Method

    public String getShippingMethod()

Get the value of shippingMethod

#### Returns

shippingMethod.

### getSpecialInstructions() Method

    public String getSpecialInstructions()

Get the value of specialInstructions

#### Returns

specialInstructions.

### getSplittingPreference() Method

    public String getSplittingPreference()

Get the value of splittingPreference

#### Returns

splittingPreference.

### getSubtotal() Method

    public double getSubtotal()

Get the value of subtotal

#### Returns

the subtotal for the order

### getTotal(int) Method

    public Money getTotal(int totalType)
         throws InvalidArgumentException

Gets the shopping cart total for the given total type

#### Parameters

totalType
  type

#### Exceptions

``InvalidArgumentException``

### isOrderLinesCollectionEmpty() Method

    public boolean isOrderLinesCollectionEmpty()

Returns true if this collection contains no elements.

### orderLinesCollectionHashCode() Method

    public int orderLinesCollectionHashCode()

Returns the hash code value for this collection.

### orderLinesCollectionIterator() Method

    public Iterator orderLinesCollectionIterator()

Returns an iterator over the elements in this collection.

### orderLinesCollectionSize() Method

    public int orderLinesCollectionSize()

Returns the number of elements in this collection.

### removeOrderLines(OrderLine) Method

    public boolean removeOrderLines(OrderLine element)

Removes a single instance of the specified element from this collection, if it is present (optional operation).

### removeOrderLinesCollection(Collection) Method

    public boolean removeOrderLinesCollection(Collection collection)

Removes all this collection's elements that are also contained in the specified collection (optional operation).

### retainOrderLinesCollection(Collection) Method

    public boolean retainOrderLinesCollection(Collection collection)

Retains only the elements in this collection that are contained in the specified collection (optional operation).

### setCreatedDate(Date) Method

    public void setCreatedDate(Date createdDate)

Set the value of createdDate

#### Parameters

createdDate
  createdDate to be added

### setCustomer(Customer) Method

    public void setCustomer(Customer customer)

Set the remote object reference of customer

#### Parameters

customer
  customer to be added

### setCustomerReference(SmartEntityReference) Method

    public void setCustomerReference(SmartEntityReference smartEntityReference)

Set the SmartEntityReference for customer

### setEntityContext(EntityContext) Method

    public void setEntityContext(EntityContext ctx)
         throws EJBException

Description copied from `EntityImpl.setEntityContext(EntityContext)`
setEntityContext method.

Overrides
  `EntityImpl.setEntityContext(EntityContext)`

#### Exceptions

``EJBException``

### setIdentifier(String) Method

    public void setIdentifier(String value)

### 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 Order value object

#### Exceptions

``RemoteException``

### setOrderLinesCollection(Collection) Method

    public void setOrderLinesCollection(Collection collection)

Sets the entire collection

### setOrderLinesCollectionReference(SmartCollectionReference) Method

    public void setOrderLinesCollectionReference(SmartCollectionReference smartCollectionReference)

Set the SmartCollectionReference for orderLines

### setOrderStatus(String) Method

    public void setOrderStatus(String orderStatus)

Set the value of orderStatus

#### Parameters

orderStatus
  orderStatus to be added

### setPaymentTransaction(PaymentTransaction) Method

    public void setPaymentTransaction(PaymentTransaction paymentTransaction)

Set the remote object reference of paymentTransaction

#### Parameters

paymentTransaction
  paymentTransaction to be added

### setPaymentTransactionReference(SmartEntityReference) Method

    public void setPaymentTransactionReference(SmartEntityReference smartEntityReference)

Set the SmartEntityReference for paymentTransaction

### setPrice(Money) Method

    public void setPrice(Money price)

Set the value of price

#### Parameters

price
  price to be added

### setShipping(Money) Method

    public void setShipping(Money shipping)

Set the value of shipping

#### Parameters

shipping
  shipping to be added

### setShippingAddress(Address) Method

    public void setShippingAddress(Address shippingAddress)

Set the value of shippingAddress

#### Parameters

shippingAddress
  shippingAddress to be added

### setShippingMethod(String) Method

    public void setShippingMethod(String shippingMethod)

Set the value of shippingMethod

#### Parameters

shippingMethod
  shippingMethod to be added

### setSpecialInstructions(String) Method

    public void setSpecialInstructions(String specialInstructions)

Set the value of specialInstructions

#### Parameters

specialInstructions
  specialInstructions to be added

### setSplittingPreference(String) Method

    public void setSplittingPreference(String splittingPreference)

Set the value of splittingPreference

#### Parameters

splittingPreference
  splittingPreference to be added

### setSubtotal(double) Method

    public void setSubtotal(double subtotal)

Sets the value of subtotal

#### Parameters

subtotal
  for the order.

### unsetEntityContext() Method

    public void unsetEntityContext()
         throws EJBException

Description copied from `EntityImpl.unsetEntityContext()`
unsetEntityContext method.

Overrides
  `EntityImpl.unsetEntityContext()`

#### Exceptions

``EJBException``