Package de.hybris.platform.returns.model

Class ReturnRequestModel

  • All Implemented Interfaces:
    java.io.Serializable
    public class ReturnRequestModel
extends ItemModel
    Generated model class for type ReturnRequest first defined at extension basecommerce.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _ORDER2RETURNREQUEST
      Generated relation code constant for relation Order2ReturnRequest defining source attribute order in extension basecommerce.
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String CODE
      Generated constant - Attribute key of ReturnRequest.code attribute defined at extension basecommerce.
      static java.lang.String CURRENCY
      Generated constant - Attribute key of ReturnRequest.currency attribute defined at extension basecommerce.
      static java.lang.String DELIVERYDOCNUMBERS
      Generated constant - Attribute key of ReturnRequest.deliveryDocNumbers attribute defined at extension sapreturnsexchange.
      static java.lang.String ORDER
      Generated constant - Attribute key of ReturnRequest.order attribute defined at extension basecommerce.
      static java.lang.String ORDERPOS
      Generated constant - Attribute key of ReturnRequest.orderPOS attribute defined at extension basecommerce.
      static java.lang.String REASONCODECANCELLATION
      Generated constant - Attribute key of ReturnRequest.reasonCodeCancellation attribute defined at extension sapreturnsexchange.
      static java.lang.String REFUNDDELIVERYCOST
      Generated constant - Attribute key of ReturnRequest.refundDeliveryCost attribute defined at extension commerceservices.
      static java.lang.String REPLACEMENTORDER
      Generated constant - Attribute key of ReturnRequest.replacementOrder attribute defined at extension basecommerce.
      static java.lang.String RETURNENTRIES
      Generated constant - Attribute key of ReturnRequest.returnEntries attribute defined at extension basecommerce.
      static java.lang.String RETURNFORM
      Generated constant - Attribute key of ReturnRequest.returnForm attribute defined at extension basecommerce.
      static java.lang.String RETURNLABEL
      Generated constant - Attribute key of ReturnRequest.returnLabel attribute defined at extension basecommerce.
      static java.lang.String RETURNPROCESS
      Generated constant - Attribute key of ReturnRequest.returnProcess attribute defined at extension basecommerce.
      static java.lang.String RETURNWAREHOUSE
      Generated constant - Attribute key of ReturnRequest.returnWarehouse attribute defined at extension basecommerce.
      static java.lang.String RMA
      Generated constant - Attribute key of ReturnRequest.RMA attribute defined at extension basecommerce.
      static java.lang.String SAPLOGICALSYSTEM
      Generated constant - Attribute key of ReturnRequest.sapLogicalSystem attribute defined at extension ysapomsreturnprocess.
      static java.lang.String SAPRETURNREQUESTS
      Generated constant - Attribute key of ReturnRequest.sapReturnRequests attribute defined at extension ysapomsreturnprocess.
      static java.lang.String SAPSALESORGANIZATION
      Generated constant - Attribute key of ReturnRequest.sapSalesOrganization attribute defined at extension ysapomsreturnprocess.
      static java.lang.String SAPSYSTEMTYPE
      Generated constant - Attribute key of ReturnRequest.sapSystemType attribute defined at extension ysapomsreturnprocess.
      static java.lang.String STATUS
      Generated constant - Attribute key of ReturnRequest.status attribute defined at extension basecommerce.
      static java.lang.String SUBTOTAL
      Generated constant - Attribute key of ReturnRequest.subtotal attribute defined at extension basecommerce.
      static java.lang.String TOTALTAX
      Generated constant - Attribute key of ReturnRequest.totalTax attribute defined at extension basecommerce.

    • Constructor Summary

      Constructors 
      Constructor Description
      ReturnRequestModel()
      Generated constructor - Default constructor for generic creation.
      ReturnRequestModel​(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      ReturnRequestModel​(java.lang.String _code)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      ReturnRequestModel​(java.lang.String _code, ItemModel _owner)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters

    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values

      • _ORDER2RETURNREQUEST

        public static final java.lang.String _ORDER2RETURNREQUEST
        Generated relation code constant for relation Order2ReturnRequest defining source attribute order in extension basecommerce.
        See Also:
        Constant Field Values

      • CODE

        public static final java.lang.String CODE
        Generated constant - Attribute key of ReturnRequest.code attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • RMA

        public static final java.lang.String RMA
        Generated constant - Attribute key of ReturnRequest.RMA attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • REPLACEMENTORDER

        public static final java.lang.String REPLACEMENTORDER
        Generated constant - Attribute key of ReturnRequest.replacementOrder attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • CURRENCY

        public static final java.lang.String CURRENCY
        Generated constant - Attribute key of ReturnRequest.currency attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • STATUS

        public static final java.lang.String STATUS
        Generated constant - Attribute key of ReturnRequest.status attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • SUBTOTAL

        public static final java.lang.String SUBTOTAL
        Generated constant - Attribute key of ReturnRequest.subtotal attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • TOTALTAX

        public static final java.lang.String TOTALTAX
        Generated constant - Attribute key of ReturnRequest.totalTax attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • RETURNLABEL

        public static final java.lang.String RETURNLABEL
        Generated constant - Attribute key of ReturnRequest.returnLabel attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • RETURNFORM

        public static final java.lang.String RETURNFORM
        Generated constant - Attribute key of ReturnRequest.returnForm attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • RETURNWAREHOUSE

        public static final java.lang.String RETURNWAREHOUSE
        Generated constant - Attribute key of ReturnRequest.returnWarehouse attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • ORDERPOS

        public static final java.lang.String ORDERPOS
        Generated constant - Attribute key of ReturnRequest.orderPOS attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • ORDER

        public static final java.lang.String ORDER
        Generated constant - Attribute key of ReturnRequest.order attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • RETURNENTRIES

        public static final java.lang.String RETURNENTRIES
        Generated constant - Attribute key of ReturnRequest.returnEntries attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • RETURNPROCESS

        public static final java.lang.String RETURNPROCESS
        Generated constant - Attribute key of ReturnRequest.returnProcess attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • REFUNDDELIVERYCOST

        public static final java.lang.String REFUNDDELIVERYCOST
        Generated constant - Attribute key of ReturnRequest.refundDeliveryCost attribute defined at extension commerceservices.
        See Also:
        Constant Field Values

      • DELIVERYDOCNUMBERS

        public static final java.lang.String DELIVERYDOCNUMBERS
        Generated constant - Attribute key of ReturnRequest.deliveryDocNumbers attribute defined at extension sapreturnsexchange.
        See Also:
        Constant Field Values

      • REASONCODECANCELLATION

        public static final java.lang.String REASONCODECANCELLATION
        Generated constant - Attribute key of ReturnRequest.reasonCodeCancellation attribute defined at extension sapreturnsexchange.
        See Also:
        Constant Field Values

      • SAPLOGICALSYSTEM

        public static final java.lang.String SAPLOGICALSYSTEM
        Generated constant - Attribute key of ReturnRequest.sapLogicalSystem attribute defined at extension ysapomsreturnprocess.
        See Also:
        Constant Field Values

      • SAPSALESORGANIZATION

        public static final java.lang.String SAPSALESORGANIZATION
        Generated constant - Attribute key of ReturnRequest.sapSalesOrganization attribute defined at extension ysapomsreturnprocess.
        See Also:
        Constant Field Values

      • SAPSYSTEMTYPE

        public static final java.lang.String SAPSYSTEMTYPE
        Generated constant - Attribute key of ReturnRequest.sapSystemType attribute defined at extension ysapomsreturnprocess.
        See Also:
        Constant Field Values

      • SAPRETURNREQUESTS

        public static final java.lang.String SAPRETURNREQUESTS
        Generated constant - Attribute key of ReturnRequest.sapReturnRequests attribute defined at extension ysapomsreturnprocess.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ReturnRequestModel

        public ReturnRequestModel()
        Generated constructor - Default constructor for generic creation.

      • ReturnRequestModel

        public ReturnRequestModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null

      • ReturnRequestModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public ReturnRequestModel​(java.lang.String _code)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _code - initial attribute declared by type ReturnRequest at extension basecommerce

      • ReturnRequestModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public ReturnRequestModel​(java.lang.String _code,
                          ItemModel _owner)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _code - initial attribute declared by type ReturnRequest at extension basecommerce
        _owner - initial attribute declared by type Item at extension core

    • Method Detail

      • getCode

        @Accessor(qualifier="code",
          type=GETTER)
public java.lang.String getCode()
        Generated method - Getter of the ReturnRequest.code attribute defined at extension basecommerce.
        Returns:
        the code

      • getCurrency

        @Accessor(qualifier="currency",
          type=GETTER)
public CurrencyModel getCurrency()
        Generated method - Getter of the ReturnRequest.currency attribute defined at extension basecommerce.
        Returns:
        the currency

      • getDeliveryDocNumbers

        @Accessor(qualifier="deliveryDocNumbers",
          type=GETTER)
public java.util.List<java.lang.String> getDeliveryDocNumbers()
        Generated method - Getter of the ReturnRequest.deliveryDocNumbers attribute defined at extension sapreturnsexchange. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the deliveryDocNumbers - holds delivery document numbers from SAP system

      • getOrder

        @Accessor(qualifier="order",
          type=GETTER)
public OrderModel getOrder()
        Generated method - Getter of the ReturnRequest.order attribute defined at extension basecommerce.
        Returns:
        the order

      • getReasonCodeCancellation

        @Accessor(qualifier="reasonCodeCancellation",
          type=GETTER)
public java.lang.String getReasonCodeCancellation()
        Generated method - Getter of the ReturnRequest.reasonCodeCancellation attribute defined at extension sapreturnsexchange.
        Returns:
        the reasonCodeCancellation - Reason Code For Cancellation

      • getRefundDeliveryCost

        @Accessor(qualifier="refundDeliveryCost",
          type=GETTER)
public java.lang.Boolean getRefundDeliveryCost()
        Generated method - Getter of the ReturnRequest.refundDeliveryCost attribute defined at extension commerceservices.
        Returns:
        the refundDeliveryCost - Include Delivery Cost in the Refund Amount

      • getReplacementOrder

        @Accessor(qualifier="replacementOrder",
          type=GETTER)
public ReplacementOrderModel getReplacementOrder()
        Generated method - Getter of the ReturnRequest.replacementOrder attribute defined at extension basecommerce.
        Returns:
        the replacementOrder

      • getReturnEntries

        @Accessor(qualifier="returnEntries",
          type=GETTER)
public java.util.List<ReturnEntryModel> getReturnEntries()
        Generated method - Getter of the ReturnRequest.returnEntries attribute defined at extension basecommerce. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the returnEntries

      • getReturnForm

        @Accessor(qualifier="returnForm",
          type=GETTER)
public MediaModel getReturnForm()
        Generated method - Getter of the ReturnRequest.returnForm attribute defined at extension basecommerce.
        Returns:
        the returnForm - The return form for the ReturnRequest.

      • getReturnLabel

        @Accessor(qualifier="returnLabel",
          type=GETTER)
public MediaModel getReturnLabel()
        Generated method - Getter of the ReturnRequest.returnLabel attribute defined at extension basecommerce.
        Returns:
        the returnLabel - The return shipping label for the ReturnRequest.

      • getReturnProcess

        @Accessor(qualifier="returnProcess",
          type=GETTER)
public java.util.Collection<ReturnProcessModel> getReturnProcess()
        Generated method - Getter of the ReturnRequest.returnProcess attribute defined at extension basecommerce. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the returnProcess

      • getReturnWarehouse

        @Accessor(qualifier="returnWarehouse",
          type=GETTER)
public WarehouseModel getReturnWarehouse()
        Generated method - Getter of the ReturnRequest.returnWarehouse attribute defined at extension basecommerce.
        Returns:
        the returnWarehouse - Determines the warehouse where the products need to be returned by the customer

      • getRMA

        @Accessor(qualifier="RMA",
          type=GETTER)
public java.lang.String getRMA()
        Generated method - Getter of the ReturnRequest.RMA attribute defined at extension basecommerce.
        Returns:
        the RMA

      • getSapLogicalSystem

        @Accessor(qualifier="sapLogicalSystem",
          type=GETTER)
public java.lang.String getSapLogicalSystem()
        Generated method - Getter of the ReturnRequest.sapLogicalSystem attribute defined at extension ysapomsreturnprocess.
        Returns:
        the sapLogicalSystem - SAP logical system

      • getSapReturnRequests

        @Accessor(qualifier="sapReturnRequests",
          type=GETTER)
public java.util.Set<SAPReturnRequestsModel> getSapReturnRequests()
        Generated method - Getter of the ReturnRequest.sapReturnRequests attribute defined at extension ysapomsreturnprocess. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the sapReturnRequests

      • getSapSalesOrganization

        @Accessor(qualifier="sapSalesOrganization",
          type=GETTER)
public SAPSalesOrganizationModel getSapSalesOrganization()
        Generated method - Getter of the ReturnRequest.sapSalesOrganization attribute defined at extension ysapomsreturnprocess.
        Returns:
        the sapSalesOrganization - SAP Sales Organization

      • getSapSystemType

        @Accessor(qualifier="sapSystemType",
          type=GETTER)
public SapSystemType getSapSystemType()
        Generated method - Getter of the ReturnRequest.sapSystemType attribute defined at extension ysapomsreturnprocess.
        Returns:
        the sapSystemType - SAP System Type

      • getStatus

        @Accessor(qualifier="status",
          type=GETTER)
public ReturnStatus getStatus()
        Generated method - Getter of the ReturnRequest.status attribute defined at extension basecommerce.
        Returns:
        the status

      • getSubtotal

        @Accessor(qualifier="subtotal",
          type=GETTER)
public java.math.BigDecimal getSubtotal()
        Generated method - Getter of the ReturnRequest.subtotal attribute defined at extension basecommerce.
        Returns:
        the subtotal

      • getTotalTax

        @Accessor(qualifier="totalTax",
          type=GETTER)
public java.math.BigDecimal getTotalTax()
        Generated method - Getter of the ReturnRequest.totalTax attribute defined at extension basecommerce.
        Returns:
        the totalTax - Total tax value for the ReturnRequest.

      • setCode

        @Accessor(qualifier="code",
          type=SETTER)
public void setCode​(java.lang.String value)
        Generated method - Setter of ReturnRequest.code attribute defined at extension basecommerce.
        Parameters:
        value - the code

      • setCurrency

        @Accessor(qualifier="currency",
          type=SETTER)
public void setCurrency​(CurrencyModel value)
        Generated method - Setter of ReturnRequest.currency attribute defined at extension basecommerce.
        Parameters:
        value - the currency

      • setDeliveryDocNumbers

        @Accessor(qualifier="deliveryDocNumbers",
          type=SETTER)
public void setDeliveryDocNumbers​(java.util.List<java.lang.String> value)
        Generated method - Setter of ReturnRequest.deliveryDocNumbers attribute defined at extension sapreturnsexchange.
        Parameters:
        value - the deliveryDocNumbers - holds delivery document numbers from SAP system

      • setOrder

        @Accessor(qualifier="order",
          type=SETTER)
public void setOrder​(OrderModel value)
        Generated method - Setter of ReturnRequest.order attribute defined at extension basecommerce.
        Parameters:
        value - the order

      • setReasonCodeCancellation

        @Accessor(qualifier="reasonCodeCancellation",
          type=SETTER)
public void setReasonCodeCancellation​(java.lang.String value)
        Generated method - Setter of ReturnRequest.reasonCodeCancellation attribute defined at extension sapreturnsexchange.
        Parameters:
        value - the reasonCodeCancellation - Reason Code For Cancellation

      • setRefundDeliveryCost

        @Accessor(qualifier="refundDeliveryCost",
          type=SETTER)
public void setRefundDeliveryCost​(java.lang.Boolean value)
        Generated method - Setter of ReturnRequest.refundDeliveryCost attribute defined at extension commerceservices.
        Parameters:
        value - the refundDeliveryCost - Include Delivery Cost in the Refund Amount

      • setReplacementOrder

        @Accessor(qualifier="replacementOrder",
          type=SETTER)
public void setReplacementOrder​(ReplacementOrderModel value)
        Generated method - Setter of ReturnRequest.replacementOrder attribute defined at extension basecommerce.
        Parameters:
        value - the replacementOrder

      • setReturnEntries

        @Accessor(qualifier="returnEntries",
          type=SETTER)
public void setReturnEntries​(java.util.List<ReturnEntryModel> value)
        Generated method - Setter of ReturnRequest.returnEntries attribute defined at extension basecommerce.
        Parameters:
        value - the returnEntries

      • setReturnForm

        @Accessor(qualifier="returnForm",
          type=SETTER)
public void setReturnForm​(MediaModel value)
        Generated method - Setter of ReturnRequest.returnForm attribute defined at extension basecommerce.
        Parameters:
        value - the returnForm - The return form for the ReturnRequest.

      • setReturnLabel

        @Accessor(qualifier="returnLabel",
          type=SETTER)
public void setReturnLabel​(MediaModel value)
        Generated method - Setter of ReturnRequest.returnLabel attribute defined at extension basecommerce.
        Parameters:
        value - the returnLabel - The return shipping label for the ReturnRequest.

      • setReturnProcess

        @Accessor(qualifier="returnProcess",
          type=SETTER)
public void setReturnProcess​(java.util.Collection<ReturnProcessModel> value)
        Generated method - Setter of ReturnRequest.returnProcess attribute defined at extension basecommerce.
        Parameters:
        value - the returnProcess

      • setReturnWarehouse

        @Accessor(qualifier="returnWarehouse",
          type=SETTER)
public void setReturnWarehouse​(WarehouseModel value)
        Generated method - Setter of ReturnRequest.returnWarehouse attribute defined at extension basecommerce.
        Parameters:
        value - the returnWarehouse - Determines the warehouse where the products need to be returned by the customer

      • setRMA

        @Accessor(qualifier="RMA",
          type=SETTER)
public void setRMA​(java.lang.String value)
        Generated method - Setter of ReturnRequest.RMA attribute defined at extension basecommerce.
        Parameters:
        value - the RMA

      • setSapLogicalSystem

        @Accessor(qualifier="sapLogicalSystem",
          type=SETTER)
public void setSapLogicalSystem​(java.lang.String value)
        Generated method - Setter of ReturnRequest.sapLogicalSystem attribute defined at extension ysapomsreturnprocess.
        Parameters:
        value - the sapLogicalSystem - SAP logical system

      • setSapReturnRequests

        @Accessor(qualifier="sapReturnRequests",
          type=SETTER)
public void setSapReturnRequests​(java.util.Set<SAPReturnRequestsModel> value)
        Generated method - Setter of ReturnRequest.sapReturnRequests attribute defined at extension ysapomsreturnprocess.
        Parameters:
        value - the sapReturnRequests

      • setSapSalesOrganization

        @Accessor(qualifier="sapSalesOrganization",
          type=SETTER)
public void setSapSalesOrganization​(SAPSalesOrganizationModel value)
        Generated method - Setter of ReturnRequest.sapSalesOrganization attribute defined at extension ysapomsreturnprocess.
        Parameters:
        value - the sapSalesOrganization - SAP Sales Organization

      • setSapSystemType

        @Accessor(qualifier="sapSystemType",
          type=SETTER)
public void setSapSystemType​(SapSystemType value)
        Generated method - Setter of ReturnRequest.sapSystemType attribute defined at extension ysapomsreturnprocess.
        Parameters:
        value - the sapSystemType - SAP System Type

      • setStatus

        @Accessor(qualifier="status",
          type=SETTER)
public void setStatus​(ReturnStatus value)
        Generated method - Setter of ReturnRequest.status attribute defined at extension basecommerce.
        Parameters:
        value - the status

      • setSubtotal

        @Accessor(qualifier="subtotal",
          type=SETTER)
public void setSubtotal​(java.math.BigDecimal value)
        Generated method - Setter of ReturnRequest.subtotal attribute defined at extension basecommerce.
        Parameters:
        value - the subtotal

      • setTotalTax

        @Accessor(qualifier="totalTax",
          type=SETTER)
public void setTotalTax​(java.math.BigDecimal value)
        Generated method - Setter of ReturnRequest.totalTax attribute defined at extension basecommerce.
        Parameters:
        value - the totalTax - Total tax value for the ReturnRequest.