CreateReturnRequestController (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- DefaultWidgetController
- - de.hybris.platform.omsbackoffice.widgets.returns.createreturnrequest.CreateReturnRequestController

```
public class CreateReturnRequestController
extends DefaultWidgetController
```
This controller creates a pop-up to create a ReturnRequestModel. It offers to select manually the reason of the return as well as the custom amount to refund for each item. If not specified, the amount to refund will be automatically set to the base price of the product. It also offer to set an optional comment.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`COLUMN_INDEX_RETURN_AMOUNT`
`protected static int`	`COLUMN_INDEX_RETURN_COMMENT`
`protected static int`	`COLUMN_INDEX_RETURN_QUANTITY`
`protected static int`	`COLUMN_INDEX_RETURN_REASON`
`protected static Object`	`COMPLETED`
`protected static String`	`IN_SOCKET`
`protected static String`	`OUT_CONFIRM`

Constructor Summary

Constructors
Constructor and Description

CreateReturnRequestController()

Constructors
Constructor and Description
`CreateReturnRequestController()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addListeners()` Add listeners on Intbox, Combobox and Textbox so that when a change happens on one of these components, we are catching it.
`protected void`	`applyToGrid(Object data, int childrenIndex)` Apply a value to the elements contained in the grid
`protected void`	`applyToRow(Object data, int childrenIndex, Component row)` Apply a specific change to a specific row of the grid
`protected void`	`autoSelect(Event event)` Automatically select the checkbox in front of the row
`protected void`	`calculateRowAmount(Row myRow, ReturnEntryToCreateDto myReturnEntry, int qtyEntered)` Calculates the total refund amount for a specific return entry according to the the quantity to return
`protected void`	`calculateTotalRefundAmount()` Calculate the total refund amount to display it to the end user
`void`	`confirmCreation()` Create the return request
`protected RefundEntryModel`	`createRefundWithCustomAmount(ReturnRequestModel returnRequest, ReturnEntryToCreateDto entry)` Create and set the custom price of the refund entry.
`protected CockpitEventQueue`	`getCockpitEventQueue()`
`protected BackofficeLocaleService`	`getCockpitLocaleService()`
`protected Optional<RefundReason>`	`getCustomSelectedRefundReason(Event event)` Gets the label for the selected refund reason in case the event has a target of Combobox
`protected EnumerationService`	`getEnumerationService()`
`EventService`	`getEventService()`
`protected ModelService`	`getModelService()`
`protected OrderModel`	`getOrder()`
`protected int`	`getReasonIndex(RefundReason refundReason)` Gets the reason index within the combobox model
`RefundService`	`getRefundService()`
`Grid`	`getReturnEntries()`
`ReturnService`	`getReturnService()`
`protected Optional<RefundReason>`	`getSelectedRefundReason(Event event)` get the corresponding refund reason according to the selected item in the combobox if existing
`protected void`	`handleGlobalComment(Event event)` Updates all entries with the selected global comment
`protected void`	`handleGlobalReason(Event event)` Updates all entries with the selected global reason
`protected void`	`handleIndividualAmountToReturn(Event event)` Calculates the row amount for a return for the selected entry after an event was triggered
`protected void`	`handleIndividualQuantityToReturn(Event event)` Calculates the row amount for a return for the selected entry after an event was triggered
`protected void`	`handleIndividualRefundReason(Event event)` Applies a refund reason to an individual entry after an event is triggered.
`protected void`	`handleRow(Row row)` Set or Reset the given row with the appropriate default informations
`void`	`initCreateReturnRequestForm(OrderModel inputOrder)` Initialize the popup to create a `ReturnRequestModel`
`protected Optional<RefundReason>`	`matchingComboboxReturnReason(String refundReasonLabel)` Retrieve the `RefundReason` according to the selected label in the combobox
`void`	`reset()` Reinitialize the popup.
`protected void`	`selectAllEntries()` Select or unselect all the rows of the grid and sets the default values for each of them
`void`	`setCockpitEventQueue(CockpitEventQueue cockpitEventQueue)`
`void`	`setCockpitLocaleService(BackofficeLocaleService cockpitLocaleService)`
`void`	`setEnumerationService(EnumerationService enumerationService)`
`void`	`setEventService(EventService eventService)`
`void`	`setModelService(ModelService modelService)`
`void`	`setOrder(OrderModel order)`
`void`	`setRefundService(RefundService refundService)`
`void`	`setReturnEntries(Grid returnEntries)`
`void`	`setReturnService(ReturnService returnService)`
`protected Component`	`targetFieldToApplyValidation(String stringToValidate, int indexLabelToCheck, int indexTargetComponent)` Retrieve the row who needs to apply a validation message
`protected void`	`validateRequest()` Check if the data provided by the form are compliant with the validation rules
`protected void`	`validateReturnEntry(ReturnEntryToCreateDto entry)` Validate each return entry and throw a `WrongValueException` if it fails any check

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

- Field Detail
  - IN_SOCKET
```
protected static final String IN_SOCKET
```
    See Also:
    
    Constant Field Values
  - OUT_CONFIRM
```
protected static final String OUT_CONFIRM
```
    See Also:
    
    Constant Field Values
  - COMPLETED
```
protected static final Object COMPLETED
```
  - COLUMN_INDEX_RETURN_QUANTITY
```
protected static final int COLUMN_INDEX_RETURN_QUANTITY
```
    See Also:
    
    Constant Field Values
  - COLUMN_INDEX_RETURN_AMOUNT
```
protected static final int COLUMN_INDEX_RETURN_AMOUNT
```
    See Also:
    
    Constant Field Values
  - COLUMN_INDEX_RETURN_REASON
```
protected static final int COLUMN_INDEX_RETURN_REASON
```
    See Also:
    
    Constant Field Values
  - COLUMN_INDEX_RETURN_COMMENT
```
protected static final int COLUMN_INDEX_RETURN_COMMENT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CreateReturnRequestController
```
public CreateReturnRequestController()
```
- Method Detail
  - initCreateReturnRequestForm
```
public void initCreateReturnRequestForm(OrderModel inputOrder)
```
    Initialize the popup to create a ReturnRequestModel
    
    Parameters:
    
    inputOrder - the order for which we want to create the return request
  - addListeners
```
protected void addListeners()
```
    Add listeners on Intbox, Combobox and Textbox so that when a change happens on one of these components, we are catching it.
  - handleIndividualAmountToReturn
```
protected void handleIndividualAmountToReturn(Event event)
```
    Calculates the row amount for a return for the selected entry after an event was triggered
    
    Parameters:
    
    event - the on change event that was triggered by the user
  - handleIndividualQuantityToReturn
```
protected void handleIndividualQuantityToReturn(Event event)
```
    Calculates the row amount for a return for the selected entry after an event was triggered
    
    Parameters:
    
    event - the on change event that was triggered by the user
  - handleIndividualRefundReason
```
protected void handleIndividualRefundReason(Event event)
```
    Applies a refund reason to an individual entry after an event is triggered.
    
    Parameters:
    
    event - the on select event that was triggered by the user
  - handleGlobalComment
```
protected void handleGlobalComment(Event event)
```
    Updates all entries with the selected global comment
    
    Parameters:
    
    event - the event that triggered the change
  - handleGlobalReason
```
protected void handleGlobalReason(Event event)
```
    Updates all entries with the selected global reason
    
    Parameters:
    
    event - the event that triggered the change
  - calculateRowAmount
```
protected void calculateRowAmount(Row myRow,
                                  ReturnEntryToCreateDto myReturnEntry,
                                  int qtyEntered)
```
    Calculates the total refund amount for a specific return entry according to the the quantity to return
    
    Parameters:
    
    myRow - the row I want the calculation to apply
    
    myReturnEntry - the targeted return entry
    
    qtyEntered - the quantity to be returned
  - calculateTotalRefundAmount
```
protected void calculateTotalRefundAmount()
```
    Calculate the total refund amount to display it to the end user
  - autoSelect
```
protected void autoSelect(Event event)
```
    Automatically select the checkbox in front of the row
    
    Parameters:
    
    event - the event that triggered the autoselect
  - handleRow
```
protected void handleRow(Row row)
```
    Set or Reset the given row with the appropriate default informations
    
    Parameters:
    
    row - the row to set/reset
  - selectAllEntries
```
protected void selectAllEntries()
```
    Select or unselect all the rows of the grid and sets the default values for each of them
  - getReasonIndex
```
protected int getReasonIndex(RefundReason refundReason)
```
    Gets the reason index within the combobox model
    
    Parameters:
    
    refundReason - the reason for which we want to know the index
    
    Returns:
    
    the index of the given refund reason
  - getSelectedRefundReason
```
protected Optional<RefundReason> getSelectedRefundReason(Event event)
```
    get the corresponding refund reason according to the selected item in the combobox if existing
    
    Parameters:
    
    event - the select event on the combobox
    
    Returns:
    
    the corresponding refund reason
  - getCustomSelectedRefundReason
```
protected Optional<RefundReason> getCustomSelectedRefundReason(Event event)
```
    Gets the label for the selected refund reason in case the event has a target of Combobox
    
    Parameters:
    
    event - the event that was fired
    
    Returns:
    
    the RefundReason corresponding to the label
  - applyToGrid
```
protected void applyToGrid(Object data,
                           int childrenIndex)
```
    Apply a value to the elements contained in the grid
    
    Parameters:
    
    data - the value to pass to the grid
    
    childrenIndex - the index indicating where to find the right component in the grid
  - applyToRow
```
protected void applyToRow(Object data,
                          int childrenIndex,
                          Component row)
```
    Apply a specific change to a specific row of the grid
    
    Parameters:
    
    data - the new value to set
    
    childrenIndex - the index of the component in the grid
    
    row - the row to which the change needs to be applied
  - reset
```
public void reset()
```
    Reinitialize the popup.
  - confirmCreation
```
public void confirmCreation()
                     throws InterruptedException
```
    Create the return request
    
    Throws:
    
    InterruptedException
  - createRefundWithCustomAmount
```
protected RefundEntryModel createRefundWithCustomAmount(ReturnRequestModel returnRequest,
                                                        ReturnEntryToCreateDto entry)
```
    Create and set the custom price of the refund entry.
    
    Parameters:
    
    returnRequest - the associated ReturnRequestModel to the RefundEntryModel
    
    entry - the RefundEntryModel use to get the custom informations
    
    Returns:
    
    the newly RefundEntryModel created
  - validateReturnEntry
```
protected void validateReturnEntry(ReturnEntryToCreateDto entry)
```
    Validate each return entry and throw a WrongValueException if it fails any check
    
    Parameters:
    
    entry - the individual entry to validate
  - validateRequest
```
protected void validateRequest()
```
    Check if the data provided by the form are compliant with the validation rules
  - targetFieldToApplyValidation
```
protected Component targetFieldToApplyValidation(String stringToValidate,
                                                 int indexLabelToCheck,
                                                 int indexTargetComponent)
```
    Retrieve the row who needs to apply a validation message
    
    Parameters:
    
    stringToValidate - the string to compare to identify a specific row in the grid
    
    indexLabelToCheck - the index of the label to which we want to compare the passed string
    
    indexTargetComponent - the index of the grid where the target component is located
  - matchingComboboxReturnReason
```
protected Optional<RefundReason> matchingComboboxReturnReason(String refundReasonLabel)
```
    Retrieve the RefundReason according to the selected label in the combobox
    
    Parameters:
    
    refundReasonLabel - a String
    
    Returns:
    
    the return reason corresponding to the label
  - getOrder
```
protected OrderModel getOrder()
```
  - setOrder
```
public void setOrder(OrderModel order)
```
  - getReturnEntries
```
public Grid getReturnEntries()
```
  - setReturnEntries
```
public void setReturnEntries(Grid returnEntries)
```
  - getReturnService
```
public ReturnService getReturnService()
```
  - getEventService
```
public EventService getEventService()
```
  - setEventService
```
public void setEventService(EventService eventService)
```
  - setReturnService
```
public void setReturnService(ReturnService returnService)
```
  - getEnumerationService
```
protected EnumerationService getEnumerationService()
```
  - setEnumerationService
```
public void setEnumerationService(EnumerationService enumerationService)
```
  - getModelService
```
protected ModelService getModelService()
```
  - setModelService
```
public void setModelService(ModelService modelService)
```
  - getCockpitLocaleService
```
protected BackofficeLocaleService getCockpitLocaleService()
```
  - setCockpitLocaleService
```
public void setCockpitLocaleService(BackofficeLocaleService cockpitLocaleService)
```
  - getCockpitEventQueue
```
protected CockpitEventQueue getCockpitEventQueue()
```
  - setCockpitEventQueue
```
public void setCockpitEventQueue(CockpitEventQueue cockpitEventQueue)
```
  - getRefundService
```
public RefundService getRefundService()
```
  - setRefundService
```
public void setRefundService(RefundService refundService)
```

Class CreateReturnRequestController

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IN_SOCKET

OUT_CONFIRM

COMPLETED

COLUMN_INDEX_RETURN_QUANTITY

COLUMN_INDEX_RETURN_AMOUNT

COLUMN_INDEX_RETURN_REASON

COLUMN_INDEX_RETURN_COMMENT

Constructor Detail

CreateReturnRequestController

Method Detail

initCreateReturnRequestForm

addListeners

handleIndividualAmountToReturn

handleIndividualQuantityToReturn

handleIndividualRefundReason

handleGlobalComment

handleGlobalReason

calculateRowAmount

calculateTotalRefundAmount

autoSelect

handleRow

selectAllEntries

getReasonIndex

getSelectedRefundReason

getCustomSelectedRefundReason

applyToGrid

applyToRow

reset

confirmCreation

createRefundWithCustomAmount

validateReturnEntry

validateRequest

targetFieldToApplyValidation

matchingComboboxReturnReason

getOrder

setOrder

getReturnEntries

setReturnEntries

getReturnService

getEventService

setEventService

setReturnService

getEnumerationService

setEnumerationService

getModelService

setModelService

getCockpitLocaleService

setCockpitLocaleService

getCockpitEventQueue

setCockpitEventQueue

getRefundService

setRefundService