Class CommerceInventoryWarehouseItemLocalServiceUtil

java.lang.Object
com.liferay.commerce.inventory.service.CommerceInventoryWarehouseItemLocalServiceUtil

public class CommerceInventoryWarehouseItemLocalServiceUtil extends Object
Provides the local service utility for CommerceInventoryWarehouseItem. This utility wraps com.liferay.commerce.inventory.service.impl.CommerceInventoryWarehouseItemLocalServiceImpl 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

    • CommerceInventoryWarehouseItemLocalServiceUtil

      public CommerceInventoryWarehouseItemLocalServiceUtil()
  • Method Details

    • addCommerceInventoryWarehouseItem

      public static CommerceInventoryWarehouseItem addCommerceInventoryWarehouseItem(CommerceInventoryWarehouseItem commerceInventoryWarehouseItem)
      Adds the commerce inventory warehouse item to the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceInventoryWarehouseItemLocalServiceImpl 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:
      commerceInventoryWarehouseItem - the commerce inventory warehouse item
      Returns:
      the commerce inventory warehouse item that was added
    • addCommerceInventoryWarehouseItem

      public static CommerceInventoryWarehouseItem addCommerceInventoryWarehouseItem(String externalReferenceCode, long userId, long commerceInventoryWarehouseId, BigDecimal quantity, String sku, String unitOfMeasureKey) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOrUpdateCommerceInventoryWarehouseItem

      public static CommerceInventoryWarehouseItem addOrUpdateCommerceInventoryWarehouseItem(String externalReferenceCode, long companyId, long userId, long commerceInventoryWarehouseId, BigDecimal quantity, String sku, String unitOfMeasureKey) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • countItemsByCompanyId

      public static int countItemsByCompanyId(long companyId, String sku, boolean replacePermissionCheck)
    • createCommerceInventoryWarehouseItem

      public static CommerceInventoryWarehouseItem createCommerceInventoryWarehouseItem(long commerceInventoryWarehouseItemId)
      Creates a new commerce inventory warehouse item with the primary key. Does not add the commerce inventory warehouse item to the database.
      Parameters:
      commerceInventoryWarehouseItemId - the primary key for the new commerce inventory warehouse item
      Returns:
      the new commerce inventory warehouse 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
    • deleteCommerceInventoryWarehouseItem

      public static CommerceInventoryWarehouseItem deleteCommerceInventoryWarehouseItem(CommerceInventoryWarehouseItem commerceInventoryWarehouseItem)
      Deletes the commerce inventory warehouse item from the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceInventoryWarehouseItemLocalServiceImpl 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:
      commerceInventoryWarehouseItem - the commerce inventory warehouse item
      Returns:
      the commerce inventory warehouse item that was removed
    • deleteCommerceInventoryWarehouseItem

      public static CommerceInventoryWarehouseItem deleteCommerceInventoryWarehouseItem(long commerceInventoryWarehouseItemId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the commerce inventory warehouse item with the primary key from the database. Also notifies the appropriate model listeners.

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

      public static void deleteCommerceInventoryWarehouseItems(long commerceInventoryWarehouseId)
    • deleteCommerceInventoryWarehouseItems

      public static void deleteCommerceInventoryWarehouseItems(long companyId, String sku, String unitOfMeasureKey)
    • deleteCommerceInventoryWarehouseItemsByCompanyId

      public static void deleteCommerceInventoryWarehouseItemsByCompanyId(long companyId)
    • 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.inventory.model.impl.CommerceInventoryWarehouseItemModelImpl.

      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.inventory.model.impl.CommerceInventoryWarehouseItemModelImpl.

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

      public static CommerceInventoryWarehouseItem fetchCommerceInventoryWarehouseItem(long commerceInventoryWarehouseItemId)
    • fetchCommerceInventoryWarehouseItem

      public static CommerceInventoryWarehouseItem fetchCommerceInventoryWarehouseItem(long commerceInventoryWarehouseId, String sku, String unitOfMeasureKey)
    • fetchCommerceInventoryWarehouseItemByExternalReferenceCode

      public static CommerceInventoryWarehouseItem fetchCommerceInventoryWarehouseItemByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchCommerceInventoryWarehouseItemByUuidAndCompanyId

      public static CommerceInventoryWarehouseItem fetchCommerceInventoryWarehouseItemByUuidAndCompanyId(String uuid, long companyId)
      Returns the commerce inventory warehouse item with the matching UUID and company.
      Parameters:
      uuid - the commerce inventory warehouse item's UUID
      companyId - the primary key of the company
      Returns:
      the matching commerce inventory warehouse item, or null if a matching commerce inventory warehouse item could not be found
    • getActionableDynamicQuery

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

      public static CommerceInventoryWarehouseItem getCommerceInventoryWarehouseItem(long commerceInventoryWarehouseItemId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the commerce inventory warehouse item with the primary key.
      Parameters:
      commerceInventoryWarehouseItemId - the primary key of the commerce inventory warehouse item
      Returns:
      the commerce inventory warehouse item
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a commerce inventory warehouse item with the primary key could not be found
    • getCommerceInventoryWarehouseItem

      public static CommerceInventoryWarehouseItem getCommerceInventoryWarehouseItem(long commerceInventoryWarehouseId, String sku, String unitOfMeasureKey) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceInventoryWarehouseItemByExternalReferenceCode

      public static CommerceInventoryWarehouseItem getCommerceInventoryWarehouseItemByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceInventoryWarehouseItemByUuidAndCompanyId

      public static CommerceInventoryWarehouseItem getCommerceInventoryWarehouseItemByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the commerce inventory warehouse item with the matching UUID and company.
      Parameters:
      uuid - the commerce inventory warehouse item's UUID
      companyId - the primary key of the company
      Returns:
      the matching commerce inventory warehouse item
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching commerce inventory warehouse item could not be found
    • getCommerceInventoryWarehouseItems

      public static List<CommerceInventoryWarehouseItem> getCommerceInventoryWarehouseItems(int start, int end)
      Returns a range of all the commerce inventory warehouse 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.inventory.model.impl.CommerceInventoryWarehouseItemModelImpl.

      Parameters:
      start - the lower bound of the range of commerce inventory warehouse items
      end - the upper bound of the range of commerce inventory warehouse items (not inclusive)
      Returns:
      the range of commerce inventory warehouse items
    • getCommerceInventoryWarehouseItems

      public static List<CommerceInventoryWarehouseItem> getCommerceInventoryWarehouseItems(long commerceInventoryWarehouseId, int start, int end)
    • getCommerceInventoryWarehouseItemsByCompanyId

      public static List<CommerceInventoryWarehouseItem> getCommerceInventoryWarehouseItemsByCompanyId(long companyId, int start, int end)
    • getCommerceInventoryWarehouseItemsByCompanyIdSkuAndUnitOfMeasureKey

      public static List<CommerceInventoryWarehouseItem> getCommerceInventoryWarehouseItemsByCompanyIdSkuAndUnitOfMeasureKey(long companyId, String sku, String unitOfMeasureKey, int start, int end, boolean replacePermissionCheck)
    • getCommerceInventoryWarehouseItemsByModifiedDate

      public static List<CommerceInventoryWarehouseItem> getCommerceInventoryWarehouseItemsByModifiedDate(long companyId, Date startDate, Date endDate, int start, int end)
    • getCommerceInventoryWarehouseItemsCount

      public static int getCommerceInventoryWarehouseItemsCount()
      Returns the number of commerce inventory warehouse items.
      Returns:
      the number of commerce inventory warehouse items
    • getCommerceInventoryWarehouseItemsCount

      public static int getCommerceInventoryWarehouseItemsCount(long commerceInventoryWarehouseId)
    • getCommerceInventoryWarehouseItemsCount

      public static int getCommerceInventoryWarehouseItemsCount(long companyId, long accountEntryId, long groupId, String sku, String unitOfMeasureKey)
    • getCommerceInventoryWarehouseItemsCount

      public static int getCommerceInventoryWarehouseItemsCount(long companyId, String sku, String unitOfMeasureKey, boolean replacePermissionCheck)
    • getCommerceInventoryWarehouseItemsCountByCompanyId

      public static int getCommerceInventoryWarehouseItemsCountByCompanyId(long companyId)
    • getCommerceInventoryWarehouseItemsCountByModifiedDate

      public static int getCommerceInventoryWarehouseItemsCountByModifiedDate(long companyId, Date startDate, Date endDate)
    • 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()
    • getItemsByCompanyId

      public static List<CIWarehouseItem> getItemsByCompanyId(long companyId, String sku, int start, int end, boolean replacePermissionCheck)
    • 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
    • getStockQuantity

      public static BigDecimal getStockQuantity(long companyId, long accountEntryId, long groupId, String sku, String unitOfMeasureKey)
    • getStockQuantity

      public static BigDecimal getStockQuantity(long companyId, String sku, String unitOfMeasureKey)
    • increaseCommerceInventoryWarehouseItemQuantity

      public static CommerceInventoryWarehouseItem increaseCommerceInventoryWarehouseItemQuantity(long userId, long commerceInventoryWarehouseItemId, BigDecimal quantity) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • moveQuantitiesBetweenWarehouses

      public static void moveQuantitiesBetweenWarehouses(long userId, long fromCommerceInventoryWarehouseId, long toCommerceInventoryWarehouseId, BigDecimal quantity, String sku, String unitOfMeasureKey) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCommerceInventoryWarehouseItem

      public static CommerceInventoryWarehouseItem updateCommerceInventoryWarehouseItem(CommerceInventoryWarehouseItem commerceInventoryWarehouseItem)
      Updates the commerce inventory warehouse item in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CommerceInventoryWarehouseItemLocalServiceImpl 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:
      commerceInventoryWarehouseItem - the commerce inventory warehouse item
      Returns:
      the commerce inventory warehouse item that was updated
    • updateCommerceInventoryWarehouseItem

      public static CommerceInventoryWarehouseItem updateCommerceInventoryWarehouseItem(long userId, long commerceInventoryWarehouseItemId, BigDecimal quantity, BigDecimal reservedQuantity, long mvccVersion) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCommerceInventoryWarehouseItem

      public static CommerceInventoryWarehouseItem updateCommerceInventoryWarehouseItem(long userId, long commerceInventoryWarehouseItemId, long mvccVersion, BigDecimal quantity, String unitOfMeasureKey) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static CommerceInventoryWarehouseItemLocalService getService()