Class ReturnActionRequest

java.lang.Object
de.hybris.platform.returns.ReturnActionRequest
Direct Known Subclasses:
ReturnActionResponse

public class ReturnActionRequest extends Object
Represents Return action requests. Instances of this class can represent:
  • Requests for approving/cancelling/receiving whole return request (all return entries of a ReturnRequest are approved/cancelled/received)
  • Requests for approving/cancelling/receiving only some of the return entries of a ReturnRequest
  • A ReturnRequest entry may be approved/cancelled/received completely (return entry is approved/cancelled/received) or partially (i.e. only return entry quantity is reduced). It is important to note that the requests represented by this class may be processed completely, declined or processed only partially by the ReturnService.
  • Constructor Details

    • ReturnActionRequest

      public ReturnActionRequest(ReturnRequestModel returnRequest)
      Creates ReturnActionRequest for ReturnRequest action Complete
      Parameters:
      returnRequest - a ReturnRequest that should be completely taking care of
    • ReturnActionRequest

      public ReturnActionRequest(ReturnRequestModel returnRequest, HybrisEnumValue actionReason)
      Creates ReturnActionRequest for ReturnRequest action Complete
      Parameters:
      actionReason - reason for complete action
      returnRequest - a ReturnRequest that should be completely taking care of
    • ReturnActionRequest

      public ReturnActionRequest(ReturnRequestModel returnRequest, HybrisEnumValue actionReason, String notes)
      Creates ReturnActionRequest for ReturnRequest action Complete
      Parameters:
      actionReason - reason for complete action
      returnRequest - a ReturnRequest that should be completely taking care of
      notes - - additional notes (i.e. from CSAdmin)
    • ReturnActionRequest

      public ReturnActionRequest(ReturnRequestModel returnRequest, List<ReturnActionEntry> returnActionEntries)
      Creates ReturnActionRequest for ReturnRequest action Partial.
      Parameters:
      returnRequest - a ReturnRquest that should be partially taking care of
      returnActionEntries - specifies how should return entries be taking care of. Each ReturnActionEntry's Quantity value specifies how many items should be taking care of from the corresponding ReturnEntry. If Quantity value equals the ReturnEntry.getQuantity() value, the whole ReturnEntry is be taking care of.
    • ReturnActionRequest

      public ReturnActionRequest(ReturnRequestModel returnRequest, List<ReturnActionEntry> returnActionEntries, String notes)
      Creates ReturnActionRequest for ReturnRequest action Partial.
      Parameters:
      returnRequest - a ReturnRquest that should be partially taking care of
      returnActionEntries - specifies how should return entries be taking care of. Each ReturnActionEntry's Quantity value specifies how many items should be taking care of from the corresponding ReturnEntry. If Quantity value equals the ReturnEntry.getQuantity() value, the whole ReturnEntry is be taking care of.
      notes - - additional notes from the CSAdmin on the whole order cancellation
  • Method Details

    • getRequestToken

      public String getRequestToken()
    • setRequestToken

      public void setRequestToken(String requestToken)
    • getActionReason

      public HybrisEnumValue getActionReason()
    • setActionReason

      public void setActionReason(HybrisEnumValue actionReason)
    • getReturnRequest

      public ReturnRequestModel getReturnRequest()
    • getEntriesToTakeAction

      public List<ReturnActionEntry> getEntriesToTakeAction()
    • getNotes

      public String getNotes()
    • setNotes

      public void setNotes(String notes)
    • isPartialAction

      public boolean isPartialAction()
    • isPartialEntryAction

      public boolean isPartialEntryAction()