Class Name

atg.commerce.approval.ApprovedDroplet

Component(s)

/atg/commerce/approval/ApprovedDroplet

The ApprovedDroplet servlet bean supports the order approval process by retrieving all orders that have been approved or rejected, and for which the approver IDs list includes the profile ID contained in the approverid parameter. The current state of an order is not considered, only whether the approver interacted with the order.

Note that the ApprovedDroplet servlet bean has a security feature that allows the current user, the approver, to view only the orders of customers for whom he or she is allowed to approve orders. This feature is enabled by default. To disable the feature, set the enableSecurity property to false.

Input Parameters

approverid (Required)
The ID of the current user profile; the approver.

numOrders
The number of orders to return on the query. This parameter is optional and typically is used to break large result sets into manageable pieces.

startIndex
The index of the first order to return. If startIndex is null, then it default to 0. This parameter is optional and typically is used to break large result sets into manageable pieces.

Output Parameters

result
The array of Order objects.

count
The number of Order objects in the result output parameter.

totalCount
The total number of Order objects that satisfied the criteria.

nextIndex
The index of the first order in the next set of results. If startIndex or numOrders was null, then this parameter will also be null.

previousIndex
The index of the first order in the previous set of results. If startIndex or numOrders was null, then this parameter will also be null.

nextIndex and previousIndex allow the user to cycle back and forth between result sets.

startRange
The 1-based index of the first Order in the set of results.

endRange
The 1-based index of the last Order in the set of results.

errorMessage
The error message to display to the user if an error occurs.

Open Parameters

output
This open parameter renders the array of Order objects set in the result output parameter.

empty
The open parameter rendered if there are no orders that have been approved and/or rejected by the current user.

error
The open parameter rendered if an error occurs.

Example

The following example retrieves from the repository the orders that have been approved and/or rejected by the current user, an approver, and lists each order’s repository ID on the page.

<dsp:droplet name="ApprovedDroplet">
 <dsp:param bean="/atg/userprofiling/Profile.repositoryId" name="approverid"/>
 <dsp:param value="0" name="startIndex"/>
 <dsp:param value="10" name="numOrders"/>
 <dsp:oparam name="output">
  <dsp:droplet name="ForEach">
    <dsp:param param="result" name="array"/>
    <dsp:param value="order" name="elementName"/>
    <dsp:oparam name="output">
     <dsp:valueof param="order.repositoryId"/><br>
    </dsp:oparam>
    <dsp:oparam name="error">
     <dsp:valueof param="errorMsg"/><br>
    </dsp:oparam>
  </dsp:droplet>
 </dsp:oparam>
</dsp:droplet>