Package de.hybris.platform.returns

Class ReturnActionEntry

java.lang.Object

de.hybris.platform.returns.ReturnActionEntry

public class ReturnActionEntry
extends java.lang.Object

Represents an action entry in a ReturnRequest Action Request or ReturnRequest Action Response. A single action entry refers to a ReturnEntry and has an actionQuantity value. actionQuantity value must be greater than zero and less than or equal to ReturnEntry.getExpectedQuantity(). if actionQuantity value is equal to the ReturnEntry quantity, the ReturnEntry is subject to complete action operation, , otherwise it is subject to partial action. In case of ReturnRequest Action Request the actionQuantity value means how many items should be taking care of from the actual ReturnEntry. In case of ReturnRequest Action Response the actionQuantity value means how many items were successfully taking care of from the actual ReturnEntry.

Constructor Summary

Constructors

Constructor	Description
ReturnActionEntry(ReturnEntryModel returnEntry)	Creates an entry that represents action of the whole Return Entry
ReturnActionEntry(ReturnEntryModel returnEntry, long actionQuantity)	Creates an entry that represents action of a part of the Return Entry (i.e.
ReturnActionEntry(ReturnEntryModel returnEntry, long actionQuantity, java.lang.String notes)	Creates an entry that represents action of a part of the Return Entry (i.e.
ReturnActionEntry(ReturnEntryModel returnEntry, long actionQuantity, java.lang.String notes, HybrisEnumValue actionReason)	Creates an entry that represents action of a part of the Return Entry partially.
ReturnActionEntry(ReturnEntryModel returnEntry, java.lang.String notes, HybrisEnumValue actionReason)	Creates an entry that represents action of a part of the Return Entry completely.

Method Summary

Modifier and Type	Method	Description
long	getActionQuantity()
HybrisEnumValue	getActionReason()
java.lang.String	getNotes()
ReturnEntryModel	getReturnEntry()
void	setActionReason(HybrisEnumValue actionReason)
void	setNotes(java.lang.String notes)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReturnActionEntry

public ReturnActionEntry(ReturnEntryModel returnEntry)

Creates an entry that represents action of the whole Return Entry

Parameters:

returnEntry -

ReturnActionEntry

public ReturnActionEntry(ReturnEntryModel returnEntry,
                         long actionQuantity)

Creates an entry that represents action of a part of the Return Entry (i.e. reducing Return Entry quantity). Reducing Return Entry quantity to zero is the same as cancelling it completely.

Parameters:

returnEntry - - return entry

actionQuantity - - how much of the entry's quantity should be taking care of

ReturnActionEntry

public ReturnActionEntry(ReturnEntryModel returnEntry,
                         long actionQuantity,
                         java.lang.String notes)

Creates an entry that represents action of a part of the Return Entry (i.e. reducing Return Entry quantity). Reducing Return Entry quantity to zero is the same as canceling it completely.

Parameters:

returnEntry - - return entry

actionQuantity - - how much of the entry's quantity should be taking care of

notes - - additional notes (I.E from CSAdmin)

ReturnActionEntry

public ReturnActionEntry(ReturnEntryModel returnEntry,
                         java.lang.String notes,
                         HybrisEnumValue actionReason)

Creates an entry that represents action of a part of the Return Entry completely.

Parameters:

returnEntry - - return entry

actionReason - - reason of this return entry action

notes - - additional notes (I.E from CSAdmin)

ReturnActionEntry

public ReturnActionEntry(ReturnEntryModel returnEntry,
                         long actionQuantity,
                         java.lang.String notes,
                         HybrisEnumValue actionReason)

Creates an entry that represents action of a part of the Return Entry partially.

Parameters:

returnEntry - - return entry

actionQuantity - - how much of the entry's quantity should be taking care of

actionReason - - reason of this return entry action

notes - - additional notes (I.E from CSAdmin)

Method Detail

getReturnEntry

public ReturnEntryModel getReturnEntry()

getActionQuantity

public long getActionQuantity()

getNotes

public java.lang.String getNotes()

setNotes

public void setNotes(java.lang.String notes)

getActionReason

public HybrisEnumValue getActionReason()

setActionReason

public void setActionReason(HybrisEnumValue actionReason)