Class CommerceShipmentLocalServiceUtil

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

public class CommerceShipmentLocalServiceUtil extends Object
Provides the local service utility for CommerceShipment. This utility wraps com.liferay.commerce.service.impl.CommerceShipmentLocalServiceImpl and is an access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
See Also:
Generated:
  • Constructor Details

    • CommerceShipmentLocalServiceUtil

      public CommerceShipmentLocalServiceUtil()
  • Method Details

    • addCommerceDeliverySubscriptionShipment

      @Deprecated public static CommerceShipment addCommerceDeliverySubscriptionShipment(long userId, long commerceOrderId, String name, String description, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, String phoneNumber) throws com.liferay.portal.kernel.exception.PortalException
      Deprecated.
      As of Cavanaugh (7.4.x), replaced by addDeliverySubscriptionCommerceShipment(long, long)
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addCommerceShipment

      public static CommerceShipment addCommerceShipment(CommerceShipment commerceShipment)
      Adds the commerce shipment to the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceShipmentLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      commerceShipment - the commerce shipment
      Returns:
      the commerce shipment that was added
    • 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
    • addDeliverySubscriptionCommerceShipment

      public static CommerceShipment addDeliverySubscriptionCommerceShipment(long userId, long commerceOrderItemId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createCommerceShipment

      public static CommerceShipment createCommerceShipment(long commerceShipmentId)
      Creates a new commerce shipment with the primary key. Does not add the commerce shipment to the database.
      Parameters:
      commerceShipmentId - the primary key for the new commerce shipment
      Returns:
      the new commerce shipment
    • createPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCommerceShipment

      public static CommerceShipment deleteCommerceShipment(CommerceShipment commerceShipment)
      Deletes the commerce shipment from the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceShipmentLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      commerceShipment - the commerce shipment
      Returns:
      the commerce shipment that was removed
    • deleteCommerceShipment

      public static CommerceShipment deleteCommerceShipment(CommerceShipment commerceShipment, boolean restoreStockQuantity) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCommerceShipment

      public static CommerceShipment deleteCommerceShipment(long commerceShipmentId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the commerce shipment with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceShipmentLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      commerceShipmentId - the primary key of the commerce shipment
      Returns:
      the commerce shipment that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a commerce shipment with the primary key could not be found
    • deletePersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
      Performs a dynamic query on the database and returns a range of the matching rows.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.commerce.model.impl.CommerceShipmentModelImpl.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      Returns:
      the range of matching rows
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
      Performs a dynamic query on the database and returns an ordered range of the matching rows.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.commerce.model.impl.CommerceShipmentModelImpl.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of matching rows
    • dynamicQueryCount

      public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchCommerceShipment

      public static CommerceShipment fetchCommerceShipment(long commerceShipmentId)
    • fetchCommerceShipmentByExternalReferenceCode

      public static CommerceShipment fetchCommerceShipmentByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchCommerceShipmentByUuidAndGroupId

      public static CommerceShipment fetchCommerceShipmentByUuidAndGroupId(String uuid, long groupId)
      Returns the commerce shipment matching the UUID and group.
      Parameters:
      uuid - the commerce shipment's UUID
      groupId - the primary key of the group
      Returns:
      the matching commerce shipment, or null if a matching commerce shipment could not be found
    • getActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getCommerceShipment

      public static CommerceShipment getCommerceShipment(long commerceShipmentId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the commerce shipment with the primary key.
      Parameters:
      commerceShipmentId - the primary key of the commerce shipment
      Returns:
      the commerce shipment
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a commerce shipment with the primary key could not be found
    • getCommerceShipmentByExternalReferenceCode

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

      public static CommerceShipment getCommerceShipmentByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the commerce shipment matching the UUID and group.
      Parameters:
      uuid - the commerce shipment's UUID
      groupId - the primary key of the group
      Returns:
      the matching commerce shipment
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching commerce shipment could not be found
    • getCommerceShipments

      public static List<CommerceShipment> getCommerceShipments(int start, int end)
      Returns a range of all the commerce shipments.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.commerce.model.impl.CommerceShipmentModelImpl.

      Parameters:
      start - the lower bound of the range of commerce shipments
      end - the upper bound of the range of commerce shipments (not inclusive)
      Returns:
      the range of commerce shipments
    • getCommerceShipments

      public static List<CommerceShipment> getCommerceShipments(long commerceOrderId, int start, int end)
    • 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
    • getCommerceShipments

      public static List<CommerceShipment> getCommerceShipments(long[] groupIds, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
    • getCommerceShipments

      public static List<CommerceShipment> getCommerceShipments(long[] groupIds, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
    • getCommerceShipments

      public static List<CommerceShipment> getCommerceShipments(long[] groupIds, long commerceAddressId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
    • getCommerceShipmentsByUuidAndCompanyId

      public static List<CommerceShipment> getCommerceShipmentsByUuidAndCompanyId(String uuid, long companyId)
      Returns all the commerce shipments matching the UUID and company.
      Parameters:
      uuid - the UUID of the commerce shipments
      companyId - the primary key of the company
      Returns:
      the matching commerce shipments, or an empty list if no matches were found
    • getCommerceShipmentsByUuidAndCompanyId

      public static List<CommerceShipment> getCommerceShipmentsByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
      Returns a range of commerce shipments matching the UUID and company.
      Parameters:
      uuid - the UUID of the commerce shipments
      companyId - the primary key of the company
      start - the lower bound of the range of commerce shipments
      end - the upper bound of the range of commerce shipments (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching commerce shipments, or an empty list if no matches were found
    • getCommerceShipmentsCount

      public static int getCommerceShipmentsCount()
      Returns the number of commerce shipments.
      Returns:
      the number of commerce shipments
    • getCommerceShipmentsCount

      public static int getCommerceShipmentsCount(long commerceOrderId)
    • 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
    • getCommerceShipmentsCount

      public static int getCommerceShipmentsCount(long[] groupIds)
    • getCommerceShipmentsCount

      public static int getCommerceShipmentsCount(long[] groupIds, int status)
    • getCommerceShipmentsCount

      public static int getCommerceShipmentsCount(long[] groupIds, long commerceAddressId)
    • getCommerceShipmentStatusesByCommerceOrderId

      public static int[] getCommerceShipmentStatusesByCommerceOrderId(long commerceOrderId)
    • getExportActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • reprocessCommerceShipment

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

      public static com.liferay.portal.kernel.search.BaseModelSearchResult<CommerceShipment> searchCommerceShipments(com.liferay.portal.kernel.search.SearchContext searchContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • searchCommerceShipmentsCount

      public static long searchCommerceShipmentsCount(com.liferay.portal.kernel.search.SearchContext searchContext) 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)
      Updates the commerce shipment in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CommerceShipmentLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      commerceShipment - the commerce shipment
      Returns:
      the commerce shipment that was updated
    • 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 CommerceShipmentLocalService getService()