Class CommerceShipmentItemLocalServiceUtil

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

public class CommerceShipmentItemLocalServiceUtil extends Object
Provides the local service utility for CommerceShipmentItem. This utility wraps com.liferay.commerce.service.impl.CommerceShipmentItemLocalServiceImpl 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

    • CommerceShipmentItemLocalServiceUtil

      public CommerceShipmentItemLocalServiceUtil()
  • Method Details

    • addCommerceShipmentItem

      public static CommerceShipmentItem addCommerceShipmentItem(CommerceShipmentItem commerceShipmentItem)
      Adds the commerce shipment item to the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceShipmentItemLocalServiceImpl 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:
      commerceShipmentItem - the commerce shipment item
      Returns:
      the commerce shipment item that was added
    • addCommerceShipmentItem

      public static CommerceShipmentItem addCommerceShipmentItem(String externalReferenceCode, long commerceShipmentId, long commerceOrderItemId, long commerceInventoryWarehouseId, BigDecimal quantity, String unitOfMeasureKey, boolean validateInventory, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addDeliverySubscriptionCommerceShipmentItem

      public static CommerceShipmentItem addDeliverySubscriptionCommerceShipmentItem(long groupId, long userId, long commerceShipmentId, long commerceOrderItemId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOrUpdateCommerceShipmentItem

      public static CommerceShipmentItem addOrUpdateCommerceShipmentItem(String externalReferenceCode, long commerceShipmentId, long commerceOrderItemId, long commerceInventoryWarehouseId, BigDecimal quantity, String unitOfMeasureKey, boolean validateInventory, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createCommerceShipmentItem

      public static CommerceShipmentItem createCommerceShipmentItem(long commerceShipmentItemId)
      Creates a new commerce shipment item with the primary key. Does not add the commerce shipment item to the database.
      Parameters:
      commerceShipmentItemId - the primary key for the new commerce shipment item
      Returns:
      the new commerce shipment item
    • 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
    • deleteCommerceShipmentItem

      public static CommerceShipmentItem deleteCommerceShipmentItem(CommerceShipmentItem commerceShipmentItem)
      Deletes the commerce shipment item from the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceShipmentItemLocalServiceImpl 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:
      commerceShipmentItem - the commerce shipment item
      Returns:
      the commerce shipment item that was removed
    • deleteCommerceShipmentItem

      public static CommerceShipmentItem deleteCommerceShipmentItem(CommerceShipmentItem commerceShipmentItem, boolean restoreStockQuantity) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCommerceShipmentItem

      public static CommerceShipmentItem deleteCommerceShipmentItem(long commerceShipmentItemId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the commerce shipment item with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceShipmentItemLocalServiceImpl 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:
      commerceShipmentItemId - the primary key of the commerce shipment item
      Returns:
      the commerce shipment item that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a commerce shipment item with the primary key could not be found
    • deleteCommerceShipmentItem

      public static void deleteCommerceShipmentItem(long commerceShipmentItemId, boolean restoreStockQuantity) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCommerceShipmentItems

      public static void deleteCommerceShipmentItems(long commerceShipmentId, boolean restoreStockQuantity) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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.CommerceShipmentItemModelImpl.

      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.CommerceShipmentItemModelImpl.

      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
    • fetchCommerceShipmentItem

      public static CommerceShipmentItem fetchCommerceShipmentItem(long commerceShipmentItemId)
    • fetchCommerceShipmentItem

      public static CommerceShipmentItem fetchCommerceShipmentItem(long commerceShipmentId, long commerceOrderItemId, long commerceInventoryWarehouseId)
    • fetchCommerceShipmentItemByExternalReferenceCode

      public static CommerceShipmentItem fetchCommerceShipmentItemByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchCommerceShipmentItemByUuidAndGroupId

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

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

      public static CommerceShipmentItem getCommerceShipmentItem(long commerceShipmentItemId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the commerce shipment item with the primary key.
      Parameters:
      commerceShipmentItemId - the primary key of the commerce shipment item
      Returns:
      the commerce shipment item
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a commerce shipment item with the primary key could not be found
    • getCommerceShipmentItemByExternalReferenceCode

      public static CommerceShipmentItem getCommerceShipmentItemByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceShipmentItemByUuidAndGroupId

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

      public static List<CommerceShipmentItem> getCommerceShipmentItems(int start, int end)
      Returns a range of all the commerce shipment items.

      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.CommerceShipmentItemModelImpl.

      Parameters:
      start - the lower bound of the range of commerce shipment items
      end - the upper bound of the range of commerce shipment items (not inclusive)
      Returns:
      the range of commerce shipment items
    • getCommerceShipmentItems

      @Deprecated public static List<CommerceShipmentItem> getCommerceShipmentItems(long commerceOrderItemId)
      Deprecated.
      As of Athanasius (7.3.x)
    • getCommerceShipmentItems

      public static List<CommerceShipmentItem> getCommerceShipmentItems(long commerceShipmentId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipmentItem> orderByComparator)
    • getCommerceShipmentItems

      public static List<CommerceShipmentItem> getCommerceShipmentItems(long commerceShipmentId, long commerceOrderItemId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipmentItem> orderByComparator)
    • getCommerceShipmentItemsByCommerceOrderItemId

      public static List<CommerceShipmentItem> getCommerceShipmentItemsByCommerceOrderItemId(long commerceOrderItemId)
    • getCommerceShipmentItemsByUuidAndCompanyId

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

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

      public static int getCommerceShipmentItemsCount()
      Returns the number of commerce shipment items.
      Returns:
      the number of commerce shipment items
    • getCommerceShipmentItemsCount

      public static int getCommerceShipmentItemsCount(long commerceShipmentId)
    • getCommerceShipmentItemsCountByCommerceOrderItemId

      public static int getCommerceShipmentItemsCountByCommerceOrderItemId(long commerceOrderItemId)
    • getCommerceShipmentOrderItemsQuantity

      public static BigDecimal getCommerceShipmentOrderItemsQuantity(long commerceShipmentId, long commerceOrderItemId)
    • 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
    • updateCommerceShipmentItem

      public static CommerceShipmentItem updateCommerceShipmentItem(CommerceShipmentItem commerceShipmentItem)
      Updates the commerce shipment item in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CommerceShipmentItemLocalServiceImpl 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:
      commerceShipmentItem - the commerce shipment item
      Returns:
      the commerce shipment item that was updated
    • updateCommerceShipmentItem

      public static CommerceShipmentItem updateCommerceShipmentItem(long commerceShipmentItemId, long commerceInventoryWarehouseId, BigDecimal quantity, boolean validateInventory) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateExternalReferenceCode

      public static CommerceShipmentItem updateExternalReferenceCode(long commerceShipmentItemId, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static CommerceShipmentItemLocalService getService()