Order Status Gear Implementation
The Order Status gear relies upon existing Portal and core Oracle ATG Web Commerce functionality. The subsections that follow describe various aspects of its implementation.
Gear Modes and Display Modes
The following table lists the gear modes used in the Order Status gear, as well as their corresponding display modes, device outputs, and gear content and configuration pages.
Gear Mode | Display Mode | Device Output | Page Fragment |
|---|
content
| Shared | HTML | OrderStatusShared.jsp
|
| Full | HTML | OrderStatusFull.jsp
|
installConfig
| Full | HTML | installConfig.jsp
|
instanceConfig
| Full | HTML | instanceConfig.jsp
|
userConfig
| Full | HTML | userConfig.jsp
|
For general information about gear modes, display modes, and device outputs, see the Designing a Gear chapter in the ATG Portal Development Guide. For general information about creating gear content and configuration pages, see the Creating Gear Page Fragments chapter in the same guide.
Components
The Order Status gear makes use of the following major components:
Component | Description |
|---|
/atg/portal/gear/GearConfigFormHandler
| Class atg.portal.framework.GearConfigFormHandler. GearConfigFormHandler is provided with the PAF. It is used in the Order Status gear configuration pages to create and manage the forms with which to set the gear’s instance and user parameters.
For more information on GearConfigFormHandler, see the Gears and the Portal Application Framework and Creating Gear Page Fragments chapters in the ATG Portal Development Guide. |
/atg/commerce/states/OrderStates
| Class atg.commerce.states.OrderStates The OrderStates component is used in instanceConfig.jsp to retrieve a list of possible order states. For each possible order state, a checkbox is rendered. If the community leader checks the checkbox, then the associated order state is included in the list of states by which the portal end user can filter orders in Full Page mode. For more information on OrderStates, see the ATG Commerce States section of the Working With Purchase Process Objects chapter in the ATG Commerce Programming Guide. |
/atg/commerce/gears/orderstatus/OrderStatusGear
| Class atg.commerce.gears.orderstatus.OrderStatusFormHandler. The OrderStatusGear form handler is used in both the Shared and Full Page content pages. On OrderStatusShared.jsp, the component is used to display orders whose states match those specified in its sharedViewStates property. By default, OrderStatusGear.sharedViewStates is set to the following: submitted,\
processing,\
pending_merchant_action,\
pending_customer_action,\
no_pending_action
On OrderStatusFull.jsp, it is used to create and manage the form that the end user can use to specify order state and sorting criteria when displaying orders. |
/atg/commerce/order/OrderLookup
| Class atg.commerce.order.OrderLookup. The OrderLookup servlet bean is used in the gear content pages to retrieve and display the user’s orders. For more information on OrderLookup, see the Implementing Order Retrieval chapter. |
Tag Libraries
The Order Status gear uses the following standard tag libraries:
For information on the DSP tag libraries, see the ATG Page Developer's Guide. For information on the PAF tag library and Jakarta’s i18n tag library, see the ATG Portal Development Guide.
No custom tag libraries were written for this gear.
