Package de.hybris.platform.returns

Class ReturnActionRequest

java.lang.Object

de.hybris.platform.returns.ReturnActionRequest

Direct Known Subclasses:

ReturnActionResponse

public class ReturnActionRequest
extends java.lang.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 Summary

Constructors

Constructor	Description
ReturnActionRequest(ReturnRequestModel returnRequest)	Creates ReturnActionRequest for ReturnRequest action Complete
ReturnActionRequest(ReturnRequestModel returnRequest, HybrisEnumValue actionReason)	Creates ReturnActionRequest for ReturnRequest action Complete
ReturnActionRequest(ReturnRequestModel returnRequest, HybrisEnumValue actionReason, java.lang.String notes)	Creates ReturnActionRequest for ReturnRequest action Complete
ReturnActionRequest(ReturnRequestModel returnRequest, java.util.List<ReturnActionEntry> returnActionEntries)	Creates ReturnActionRequest for ReturnRequest action Partial.
ReturnActionRequest(ReturnRequestModel returnRequest, java.util.List<ReturnActionEntry> returnActionEntries, java.lang.String notes)	Creates ReturnActionRequest for ReturnRequest action Partial.

Method Summary

Modifier and Type	Method	Description
HybrisEnumValue	getActionReason()
java.util.List<ReturnActionEntry>	getEntriesToTakeAction()
java.lang.String	getNotes()
java.lang.String	getRequestToken()
ReturnRequestModel	getReturnRequest()
boolean	isPartialAction()
boolean	isPartialEntryAction()
void	setActionReason(HybrisEnumValue actionReason)
void	setNotes(java.lang.String notes)
void	setRequestToken(java.lang.String requestToken)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

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,
                           java.lang.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,
                           java.util.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,
                           java.util.List<ReturnActionEntry> returnActionEntries,
                           java.lang.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 Detail

getRequestToken

public java.lang.String getRequestToken()

setRequestToken

public void setRequestToken(java.lang.String requestToken)

getActionReason

public HybrisEnumValue getActionReason()

setActionReason

public void setActionReason(HybrisEnumValue actionReason)

getReturnRequest

public ReturnRequestModel getReturnRequest()

getEntriesToTakeAction

public java.util.List<ReturnActionEntry> getEntriesToTakeAction()

getNotes

public java.lang.String getNotes()

setNotes

public void setNotes(java.lang.String notes)

isPartialAction

public boolean isPartialAction()

isPartialEntryAction

public boolean isPartialEntryAction()