Class CommerceShipmentServiceUtil

java.lang.Object
com.liferay.commerce.service.CommerceShipmentServiceUtil

public class CommerceShipmentServiceUtil extends Object
Provides the remote service utility for CommerceShipment. This utility wraps com.liferay.commerce.service.impl.CommerceShipmentServiceImpl and is an access point for service operations in application layer code running on a remote server. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
See Also:
Generated:
  • Constructor Details

    • CommerceShipmentServiceUtil

      public CommerceShipmentServiceUtil()
  • Method Details

    • addCommerceShipment

      public static CommerceShipment addCommerceShipment(long commerceOrderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addCommerceShipment

      public static CommerceShipment addCommerceShipment(String externalReferenceCode, long groupId, long commerceAccountId, long commerceAddressId, long commerceShippingMethodId, String commerceShippingOptionName, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCommerceShipment

      @Deprecated public static void deleteCommerceShipment(long commerceShipmentId) throws com.liferay.portal.kernel.exception.PortalException
      Deprecated.
      As of Mueller (7.2.x), pass boolean for restoring stock
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCommerceShipment

      public static void deleteCommerceShipment(long commerceShipmentId, boolean restoreStockQuantity) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchCommerceShipmentByExternalReferenceCode

      public static CommerceShipment fetchCommerceShipmentByExternalReferenceCode(long companyId, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceShipment

      public static CommerceShipment getCommerceShipment(long commerceShipmentId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceShipments

      public static List<CommerceShipment> getCommerceShipments(long companyId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceShipments

      public static List<CommerceShipment> getCommerceShipments(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceShipments

      public static List<CommerceShipment> getCommerceShipments(long companyId, long commerceAddressId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceShipments

      public static List<CommerceShipment> getCommerceShipments(long companyId, long[] groupIds, long[] commerceAccountIds, String keywords, int[] shipmentStatuses, boolean excludeShipmentStatus, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceShipmentsByOrderId

      public static List<CommerceShipment> getCommerceShipmentsByOrderId(long commerceOrderId, int start, int end)
    • getCommerceShipmentsCount

      public static int getCommerceShipmentsCount(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceShipmentsCount

      public static int getCommerceShipmentsCount(long companyId, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceShipmentsCount

      public static int getCommerceShipmentsCount(long companyId, long commerceAddressId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceShipmentsCount

      public static int getCommerceShipmentsCount(long companyId, long[] groupIds, long[] commerceAccountIds, String keywords, int[] shipmentStatuses, boolean excludeShipmentStatus) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceShipmentsCountByOrderId

      public static int getCommerceShipmentsCountByOrderId(long commerceOrderId)
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • reprocessCommerceShipment

      public static CommerceShipment reprocessCommerceShipment(long commerceShipmentId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateAddress

      public static CommerceShipment updateAddress(String externalReferenceCode, long commerceShipmentId, String name, String description, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, String phoneNumber, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCarrierDetails

      public static CommerceShipment updateCarrierDetails(long commerceShipmentId, long commerceShippingMethodId, String carrier, String trackingNumber, String trackingURL) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCommerceShipment

      public static CommerceShipment updateCommerceShipment(CommerceShipment commerceShipment) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCommerceShipment

      public static CommerceShipment updateCommerceShipment(long commerceShipmentId, long commerceShippingMethodId, String carrier, int expectedDateMonth, int expectedDateDay, int expectedDateYear, int expectedDateHour, int expectedDateMinute, int shippingDateMonth, int shippingDateDay, int shippingDateYear, int shippingDateHour, int shippingDateMinute, String trackingNumber, String trackingURL, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCommerceShipment

      public static CommerceShipment updateCommerceShipment(long commerceShipmentId, long commerceShippingMethodId, String carrier, int expectedDateMonth, int expectedDateDay, int expectedDateYear, int expectedDateHour, int expectedDateMinute, int shippingDateMonth, int shippingDateDay, int shippingDateYear, int shippingDateHour, int shippingDateMinute, String trackingNumber, String trackingURL, int status, String name, String description, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, String phoneNumber, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateExpectedDate

      public static CommerceShipment updateExpectedDate(long commerceShipmentId, int expectedDateMonth, int expectedDateDay, int expectedDateYear, int expectedDateHour, int expectedDateMinute) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateExternalReferenceCode

      public static CommerceShipment updateExternalReferenceCode(long commerceShipmentId, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateShippingDate

      public static CommerceShipment updateShippingDate(long commerceShipmentId, int shippingDateMonth, int shippingDateDay, int shippingDateYear, int shippingDateHour, int shippingDateMinute) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStatus

      public static CommerceShipment updateStatus(long commerceShipmentId, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static CommerceShipmentService getService()