Class ConsignmentModel

All Implemented Interfaces:
Serializable

public class ConsignmentModel extends ItemModel
Generated model class for type Consignment first defined at extension basecommerce.
See Also:
  • Field Details

    • _TYPECODE

      public static final String _TYPECODE
      Generated model type code constant.
      See Also:
    • _CONSIGNMENTENTRYCONSIGNMENTRELATION

      public static final String _CONSIGNMENTENTRYCONSIGNMENTRELATION
      Generated relation code constant for relation ConsignmentEntryConsignmentRelation defining source attribute consignmentEntries in extension basecommerce.
      See Also:
    • CODE

      public static final String CODE
      Generated constant - Attribute key of Consignment.code attribute defined at extension basecommerce.
      See Also:
    • SHIPPINGADDRESS

      public static final String SHIPPINGADDRESS
      Generated constant - Attribute key of Consignment.shippingAddress attribute defined at extension basecommerce.
      See Also:
    • DELIVERYMODE

      public static final String DELIVERYMODE
      Generated constant - Attribute key of Consignment.deliveryMode attribute defined at extension basecommerce.
      See Also:
    • NAMEDDELIVERYDATE

      public static final String NAMEDDELIVERYDATE
      Generated constant - Attribute key of Consignment.namedDeliveryDate attribute defined at extension basecommerce.
      See Also:
    • SHIPPINGDATE

      public static final String SHIPPINGDATE
      Generated constant - Attribute key of Consignment.shippingDate attribute defined at extension basecommerce.
      See Also:
    • TRACKINGID

      public static final String TRACKINGID
      Generated constant - Attribute key of Consignment.trackingID attribute defined at extension basecommerce.
      See Also:
    • CARRIER

      public static final String CARRIER
      Generated constant - Attribute key of Consignment.carrier attribute defined at extension basecommerce.
      See Also:
    • STATUS

      public static final String STATUS
      Generated constant - Attribute key of Consignment.status attribute defined at extension basecommerce.
      See Also:
    • WAREHOUSE

      public static final String WAREHOUSE
      Generated constant - Attribute key of Consignment.warehouse attribute defined at extension basecommerce.
      See Also:
    • CONSIGNMENTENTRIES

      public static final String CONSIGNMENTENTRIES
      Generated constant - Attribute key of Consignment.consignmentEntries attribute defined at extension basecommerce.
      See Also:
    • ORDER

      public static final String ORDER
      Generated constant - Attribute key of Consignment.order attribute defined at extension basecommerce.
      See Also:
    • CONSIGNMENTPROCESSES

      public static final String CONSIGNMENTPROCESSES
      Generated constant - Attribute key of Consignment.consignmentProcesses attribute defined at extension basecommerce.
      See Also:
    • DELIVERYPOINTOFSERVICE

      public static final String DELIVERYPOINTOFSERVICE
      Generated constant - Attribute key of Consignment.deliveryPointOfService attribute defined at extension commerceservices.
      See Also:
    • STATUSDISPLAY

      public static final String STATUSDISPLAY
      Generated constant - Attribute key of Consignment.statusDisplay attribute defined at extension acceleratorservices.
      See Also:
    • CARRIERDETAILS

      public static final String CARRIERDETAILS
      Generated constant - Attribute key of Consignment.carrierDetails attribute defined at extension consignmenttrackingservices.
      See Also:
    • TOTALPRICE

      public static final String TOTALPRICE
      Generated constant - Attribute key of Consignment.totalPrice attribute defined at extension marketplaceservices.
      See Also:
    • PACKAGINGINFO

      public static final String PACKAGINGINFO
      Generated constant - Attribute key of Consignment.packagingInfo attribute defined at extension warehousing.
      See Also:
    • SHIPPINGLABEL

      public static final String SHIPPINGLABEL
      Generated constant - Attribute key of Consignment.shippingLabel attribute defined at extension warehousing.
      See Also:
    • RETURNLABEL

      public static final String RETURNLABEL
      Generated constant - Attribute key of Consignment.returnLabel attribute defined at extension warehousing.
      See Also:
    • RETURNFORM

      public static final String RETURNFORM
      Generated constant - Attribute key of Consignment.returnForm attribute defined at extension warehousing.
      See Also:
    • TASKASSIGNMENTWORKFLOW

      public static final String TASKASSIGNMENTWORKFLOW
      Generated constant - Attribute key of Consignment.taskAssignmentWorkflow attribute defined at extension warehousing.
      See Also:
    • FULFILLMENTSYSTEMCONFIG

      public static final String FULFILLMENTSYSTEMCONFIG
      Generated constant - Attribute key of Consignment.fulfillmentSystemConfig attribute defined at extension warehousing.
      See Also:
    • PACKAGINGINFOS

      public static final String PACKAGINGINFOS
      Generated constant - Attribute key of Consignment.packaginginfos attribute defined at extension warehousing.
      See Also:
    • PAYMENTTRANSACTIONENTRIES

      public static final String PAYMENTTRANSACTIONENTRIES
      Generated constant - Attribute key of Consignment.paymentTransactionEntries attribute defined at extension warehousing.
      See Also:
  • Constructor Details

    • ConsignmentModel

      public ConsignmentModel()
      Generated constructor - Default constructor for generic creation.
    • ConsignmentModel

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

      @Deprecated(since="4.1.1", forRemoval=true) public ConsignmentModel(String _code, AddressModel _shippingAddress, ConsignmentStatus _status, WarehouseModel _warehouse)
      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 Consignment at extension basecommerce
      _shippingAddress - initial attribute declared by type Consignment at extension basecommerce
      _status - initial attribute declared by type Consignment at extension basecommerce
      _warehouse - initial attribute declared by type Consignment at extension basecommerce
    • ConsignmentModel

      @Deprecated(since="4.1.1", forRemoval=true) public ConsignmentModel(String _code, DeliveryModeModel _deliveryMode, Date _namedDeliveryDate, AbstractOrderModel _order, ItemModel _owner, AddressModel _shippingAddress, ConsignmentStatus _status, WarehouseModel _warehouse)
      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 Consignment at extension basecommerce
      _deliveryMode - initial attribute declared by type Consignment at extension basecommerce
      _namedDeliveryDate - initial attribute declared by type Consignment at extension basecommerce
      _order - initial attribute declared by type Consignment at extension basecommerce
      _owner - initial attribute declared by type Item at extension core
      _shippingAddress - initial attribute declared by type Consignment at extension basecommerce
      _status - initial attribute declared by type Consignment at extension basecommerce
      _warehouse - initial attribute declared by type Consignment at extension basecommerce
  • Method Details

    • getCarrier

      @Accessor(qualifier="carrier", type=GETTER) public String getCarrier()
      Generated method - Getter of the Consignment.carrier attribute defined at extension basecommerce.
      Returns:
      the carrier
    • getCarrierDetails

      @Accessor(qualifier="carrierDetails", type=GETTER) public CarrierModel getCarrierDetails()
      Generated method - Getter of the Consignment.carrierDetails attribute defined at extension consignmenttrackingservices.
      Returns:
      the carrierDetails
    • getCode

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

      @Accessor(qualifier="consignmentEntries", type=GETTER) public Set<ConsignmentEntryModel> getConsignmentEntries()
      Generated method - Getter of the Consignment.consignmentEntries attribute defined at extension basecommerce. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the consignmentEntries
    • getConsignmentProcesses

      @Accessor(qualifier="consignmentProcesses", type=GETTER) public Collection<ConsignmentProcessModel> getConsignmentProcesses()
      Generated method - Getter of the Consignment.consignmentProcesses attribute defined at extension basecommerce. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the consignmentProcesses
    • getDeliveryMode

      @Accessor(qualifier="deliveryMode", type=GETTER) public DeliveryModeModel getDeliveryMode()
      Generated method - Getter of the Consignment.deliveryMode attribute defined at extension basecommerce.
      Returns:
      the deliveryMode
    • getDeliveryPointOfService

      @Accessor(qualifier="deliveryPointOfService", type=GETTER) public PointOfServiceModel getDeliveryPointOfService()
      Generated method - Getter of the Consignment.deliveryPointOfService attribute defined at extension commerceservices.
      Returns:
      the deliveryPointOfService - The point of service to deliver to/collect from.
    • getFulfillmentSystemConfig

      @Accessor(qualifier="fulfillmentSystemConfig", type=GETTER) public Object getFulfillmentSystemConfig()
      Generated method - Getter of the Consignment.fulfillmentSystemConfig attribute defined at extension warehousing.
      Returns:
      the fulfillmentSystemConfig - Property that represents configuration to route the fulfillment of a consignment
    • getNamedDeliveryDate

      @Accessor(qualifier="namedDeliveryDate", type=GETTER) public Date getNamedDeliveryDate()
      Generated method - Getter of the Consignment.namedDeliveryDate attribute defined at extension basecommerce.
      Returns:
      the namedDeliveryDate
    • getOrder

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

      @Accessor(qualifier="packagingInfo", type=GETTER) public PackagingInfoModel getPackagingInfo()
      Generated method - Getter of the Consignment.packagingInfo attribute defined at extension warehousing.
      Returns:
      the packagingInfo
    • getPackaginginfos

      @Accessor(qualifier="packaginginfos", type=GETTER) public List<PackagingInfoModel> getPackaginginfos()
      Generated method - Getter of the Consignment.packaginginfos attribute defined at extension warehousing. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the packaginginfos
    • getPaymentTransactionEntries

      @Accessor(qualifier="paymentTransactionEntries", type=GETTER) public Set<PaymentTransactionEntryModel> getPaymentTransactionEntries()
      Generated method - Getter of the Consignment.paymentTransactionEntries attribute defined at extension warehousing. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the paymentTransactionEntries
    • getReturnForm

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

      @Accessor(qualifier="returnLabel", type=GETTER) public MediaModel getReturnLabel()
      Generated method - Getter of the Consignment.returnLabel attribute defined at extension warehousing.
      Returns:
      the returnLabel - The return label for the consignment.
    • getShippingAddress

      @Accessor(qualifier="shippingAddress", type=GETTER) public AddressModel getShippingAddress()
      Generated method - Getter of the Consignment.shippingAddress attribute defined at extension basecommerce.
      Returns:
      the shippingAddress
    • getShippingDate

      @Accessor(qualifier="shippingDate", type=GETTER) public Date getShippingDate()
      Generated method - Getter of the Consignment.shippingDate attribute defined at extension basecommerce.
      Returns:
      the shippingDate
    • getShippingLabel

      @Accessor(qualifier="shippingLabel", type=GETTER) public MediaModel getShippingLabel()
      Generated method - Getter of the Consignment.shippingLabel attribute defined at extension warehousing.
      Returns:
      the shippingLabel - The shipping label for the consignment.
    • getStatus

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

      @Accessor(qualifier="statusDisplay", type=GETTER) public String getStatusDisplay()
      Generated method - Getter of the Consignment.statusDisplay dynamic attribute defined at extension acceleratorservices.
      Returns:
      the statusDisplay
    • getTaskAssignmentWorkflow

      @Accessor(qualifier="taskAssignmentWorkflow", type=GETTER) public String getTaskAssignmentWorkflow()
      Generated method - Getter of the Consignment.taskAssignmentWorkflow attribute defined at extension warehousing.
      Returns:
      the taskAssignmentWorkflow - The task assignment workflow code assigned to the consignment.
    • getTotalPrice

      @Accessor(qualifier="totalPrice", type=GETTER) public Double getTotalPrice()
      Generated method - Getter of the Consignment.totalPrice attribute defined at extension marketplaceservices.
      Returns:
      the totalPrice
    • getTrackingID

      @Accessor(qualifier="trackingID", type=GETTER) public String getTrackingID()
      Generated method - Getter of the Consignment.trackingID attribute defined at extension basecommerce.
      Returns:
      the trackingID
    • getWarehouse

      @Accessor(qualifier="warehouse", type=GETTER) public WarehouseModel getWarehouse()
      Generated method - Getter of the Consignment.warehouse attribute defined at extension basecommerce.
      Returns:
      the warehouse
    • setCarrier

      @Accessor(qualifier="carrier", type=SETTER) public void setCarrier(String value)
      Generated method - Setter of Consignment.carrier attribute defined at extension basecommerce.
      Parameters:
      value - the carrier
    • setCarrierDetails

      @Accessor(qualifier="carrierDetails", type=SETTER) public void setCarrierDetails(CarrierModel value)
      Generated method - Setter of Consignment.carrierDetails attribute defined at extension consignmenttrackingservices.
      Parameters:
      value - the carrierDetails
    • setCode

      @Accessor(qualifier="code", type=SETTER) public void setCode(String value)
      Generated method - Initial setter of Consignment.code attribute defined at extension basecommerce. Can only be used at creation of model - before first save.
      Parameters:
      value - the code
    • setConsignmentEntries

      @Accessor(qualifier="consignmentEntries", type=SETTER) public void setConsignmentEntries(Set<ConsignmentEntryModel> value)
      Generated method - Setter of Consignment.consignmentEntries attribute defined at extension basecommerce.
      Parameters:
      value - the consignmentEntries
    • setConsignmentProcesses

      @Accessor(qualifier="consignmentProcesses", type=SETTER) public void setConsignmentProcesses(Collection<ConsignmentProcessModel> value)
      Generated method - Setter of Consignment.consignmentProcesses attribute defined at extension basecommerce.
      Parameters:
      value - the consignmentProcesses
    • setDeliveryMode

      @Accessor(qualifier="deliveryMode", type=SETTER) public void setDeliveryMode(DeliveryModeModel value)
      Generated method - Initial setter of Consignment.deliveryMode attribute defined at extension basecommerce. Can only be used at creation of model - before first save.
      Parameters:
      value - the deliveryMode
    • setDeliveryPointOfService

      @Accessor(qualifier="deliveryPointOfService", type=SETTER) public void setDeliveryPointOfService(PointOfServiceModel value)
      Generated method - Setter of Consignment.deliveryPointOfService attribute defined at extension commerceservices.
      Parameters:
      value - the deliveryPointOfService - The point of service to deliver to/collect from.
    • setFulfillmentSystemConfig

      @Accessor(qualifier="fulfillmentSystemConfig", type=SETTER) public void setFulfillmentSystemConfig(Object value)
      Generated method - Setter of Consignment.fulfillmentSystemConfig attribute defined at extension warehousing.
      Parameters:
      value - the fulfillmentSystemConfig - Property that represents configuration to route the fulfillment of a consignment
    • setNamedDeliveryDate

      @Accessor(qualifier="namedDeliveryDate", type=SETTER) public void setNamedDeliveryDate(Date value)
      Generated method - Initial setter of Consignment.namedDeliveryDate attribute defined at extension basecommerce. Can only be used at creation of model - before first save.
      Parameters:
      value - the namedDeliveryDate
    • setOrder

      @Accessor(qualifier="order", type=SETTER) public void setOrder(AbstractOrderModel value)
      Generated method - Initial setter of Consignment.order attribute defined at extension basecommerce. Can only be used at creation of model - before first save.
      Parameters:
      value - the order
    • setPackagingInfo

      @Accessor(qualifier="packagingInfo", type=SETTER) public void setPackagingInfo(PackagingInfoModel value)
      Generated method - Setter of Consignment.packagingInfo attribute defined at extension warehousing.
      Parameters:
      value - the packagingInfo
    • setPackaginginfos

      @Accessor(qualifier="packaginginfos", type=SETTER) public void setPackaginginfos(List<PackagingInfoModel> value)
      Generated method - Setter of Consignment.packaginginfos attribute defined at extension warehousing.
      Parameters:
      value - the packaginginfos
    • setPaymentTransactionEntries

      @Accessor(qualifier="paymentTransactionEntries", type=SETTER) public void setPaymentTransactionEntries(Set<PaymentTransactionEntryModel> value)
      Generated method - Setter of Consignment.paymentTransactionEntries attribute defined at extension warehousing.
      Parameters:
      value - the paymentTransactionEntries
    • setReturnForm

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

      @Accessor(qualifier="returnLabel", type=SETTER) public void setReturnLabel(MediaModel value)
      Generated method - Setter of Consignment.returnLabel attribute defined at extension warehousing.
      Parameters:
      value - the returnLabel - The return label for the consignment.
    • setShippingAddress

      @Accessor(qualifier="shippingAddress", type=SETTER) public void setShippingAddress(AddressModel value)
      Generated method - Initial setter of Consignment.shippingAddress attribute defined at extension basecommerce. Can only be used at creation of model - before first save.
      Parameters:
      value - the shippingAddress
    • setShippingDate

      @Accessor(qualifier="shippingDate", type=SETTER) public void setShippingDate(Date value)
      Generated method - Setter of Consignment.shippingDate attribute defined at extension basecommerce.
      Parameters:
      value - the shippingDate
    • setShippingLabel

      @Accessor(qualifier="shippingLabel", type=SETTER) public void setShippingLabel(MediaModel value)
      Generated method - Setter of Consignment.shippingLabel attribute defined at extension warehousing.
      Parameters:
      value - the shippingLabel - The shipping label for the consignment.
    • setStatus

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

      @Accessor(qualifier="taskAssignmentWorkflow", type=SETTER) public void setTaskAssignmentWorkflow(String value)
      Generated method - Setter of Consignment.taskAssignmentWorkflow attribute defined at extension warehousing.
      Parameters:
      value - the taskAssignmentWorkflow - The task assignment workflow code assigned to the consignment.
    • setTotalPrice

      @Accessor(qualifier="totalPrice", type=SETTER) public void setTotalPrice(Double value)
      Generated method - Setter of Consignment.totalPrice attribute defined at extension marketplaceservices.
      Parameters:
      value - the totalPrice
    • setTrackingID

      @Accessor(qualifier="trackingID", type=SETTER) public void setTrackingID(String value)
      Generated method - Setter of Consignment.trackingID attribute defined at extension basecommerce.
      Parameters:
      value - the trackingID
    • setWarehouse

      @Accessor(qualifier="warehouse", type=SETTER) public void setWarehouse(WarehouseModel value)
      Generated method - Initial setter of Consignment.warehouse attribute defined at extension basecommerce. Can only be used at creation of model - before first save.
      Parameters:
      value - the warehouse