Servlet Beans and Form Handlers for Approving Orders

The following servlet beans and form handlers are used for approving orders.

Find Pending Approvals Droplet Servlet Bean

Returns all approval items for the given approvalType with a state of PENDING. If no approvalType is provided, all approvalTypes are returned.

Class

atg.commerce.csr.approvals.FindPendingApprovalsDroplet

Components

/atg/commerce/custsvc/approvals/FindPendingApprovalsDroplet

Parameters:
approvalType – Looks for items that are pending
elementName – The name of the return element

Get Total Approvals For State Droplet Servlet Bean

This servlet bean queries the approvals repository and returns the total number of results for a given type of approval.

Class

atg.commerce.csr.approvals.GetTotalApprovalsForStateDroplet

Components

/atg/commerce/custsvc/approvals/order/
    GetTotalPendingOrderApprovalsDroplet

Is Order Pending Approval Droplet Servlet Bean

This servlet bean determines if an order is currently pending approval and returns the approval ID that is associated with the order.

The servlet bean is used on confirmation pages to determine if an order emerged from the submission process in a PENDING approval state. It is also used on the Order View page to determine if “Approve” or “Reject” elements should appear.

Class

atg.commerce.csr.approvals.order.IsOrderPendingApprovalDroplet

Components

/atg/commerce/custsvc/approvals/order/
    IsOrderPendingApprovalDroplet

Parameters:
orderId
elementName – The name of the return element

Get Total Order Appeasements Droplet Servlet Bean

This servlet bean determines if an order has any appeasements applied to it, and returns the total number of appeasements if any are found.

Class

atg.commerce.csr.order.GetTotalOrderAppeasementsDroplet

Components

/atg/commerce/custsvc/order/
    GetTotalAppeasementsForOrderDroplet.properties

Parameters:
order
elementName – The name of the return element

For example:

<dsp:droplet name="/atg/commerce/custsvc/approvals/order/
      GetTotalOrderAppeasements">
  <dsp:param name="order" value="order">
  <dsp:oparam name="output">
    <dsp:valueof param="element"/>
  </dsp:oparam>
</dsp:droplet>
Get Total Approvals for State Droplet Servlet Bean

Queries the approvals repository and returns the total number of results for a given type of approval.

Class

atg.commerce.csr.approvals.GetTotalApprovalsForStateDroplet

Components

/atg/commerce/custsvc/approvals/order/
    GetTotalPendingOrderApprovalsDroplet

Is Order Adjusted Droplet Servlet Bean

Determines if the order contains any price adjustments.

Class

atg.commerce.csr.order.IsOrderAdjustedDroplet

Components

/atg/commerce/custsvc/order/IsOrderAdjustedDroplet

Parameter:
order – The order that contains adjustments

Order Approval Form Handler

The OrderApprovalFormHandler (the atg.commerce.csr.approvals.order class) generates the order approval within the UI and extends the EnvironmentChangeFormHandler. This form handler provides handlers for both approving, handleApprove, and rejecting, handleReject, an approval request. It also contains e-mail templates for approvals and rejections.

Approval Repository Query Form Handler

The ApprovalRepositoryQueryFormHandler finds approvals of a specified state and type. It handles the search request from the UI and returns a list of search results, as well as handles paging of the search results. This form handler extends the RepositoryQueryTableFormHandler.

Update Order Approval Customer Email Form Handler

The UpdateOrderApprovalCustomerEmailFormHandler updates the customer e-mail address on an order approval object.