Class CPConfigurationEntryLocalServiceUtil

java.lang.Object
com.liferay.commerce.product.service.CPConfigurationEntryLocalServiceUtil

public class CPConfigurationEntryLocalServiceUtil extends Object
Provides the local service utility for CPConfigurationEntry. This utility wraps com.liferay.commerce.product.service.impl.CPConfigurationEntryLocalServiceImpl 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

    • CPConfigurationEntryLocalServiceUtil

      public CPConfigurationEntryLocalServiceUtil()
  • Method Details

    • addCPConfigurationEntry

      public static CPConfigurationEntry addCPConfigurationEntry(CPConfigurationEntry cpConfigurationEntry)
      Adds the cp configuration entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect CPConfigurationEntryLocalServiceImpl 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:
      cpConfigurationEntry - the cp configuration entry
      Returns:
      the cp configuration entry that was added
    • addCPConfigurationEntry

      public static CPConfigurationEntry addCPConfigurationEntry(String externalReferenceCode, long userId, long groupId, long classNameId, long classPK, long cpConfigurationListId, long cpTaxCategoryId, String allowedOrderQuantities, boolean backOrders, long commerceAvailabilityEstimateId, String cpDefinitionInventoryEngine, double depth, boolean displayAvailability, boolean displayStockQuantity, boolean freeShipping, double height, String lowStockActivity, BigDecimal maxOrderQuantity, BigDecimal minOrderQuantity, BigDecimal minStockQuantity, BigDecimal multipleOrderQuantity, boolean purchasable, boolean shippable, double shippingExtraPrice, boolean shipSeparately, boolean taxExempt, boolean visible, double weight, double width) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createCPConfigurationEntry

      public static CPConfigurationEntry createCPConfigurationEntry(long CPConfigurationEntryId)
      Creates a new cp configuration entry with the primary key. Does not add the cp configuration entry to the database.
      Parameters:
      CPConfigurationEntryId - the primary key for the new cp configuration entry
      Returns:
      the new cp configuration entry
    • 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
    • deleteCPConfigurationEntries

      public static void deleteCPConfigurationEntries(long cpConfigurationListId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCPConfigurationEntries

      public static void deleteCPConfigurationEntries(long classNameId, long classPK) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCPConfigurationEntry

      public static CPConfigurationEntry deleteCPConfigurationEntry(CPConfigurationEntry cpConfigurationEntry) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the cp configuration entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect CPConfigurationEntryLocalServiceImpl 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:
      cpConfigurationEntry - the cp configuration entry
      Returns:
      the cp configuration entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCPConfigurationEntry

      public static CPConfigurationEntry deleteCPConfigurationEntry(long CPConfigurationEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the cp configuration entry with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect CPConfigurationEntryLocalServiceImpl 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:
      CPConfigurationEntryId - the primary key of the cp configuration entry
      Returns:
      the cp configuration entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a cp configuration entry 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.product.model.impl.CPConfigurationEntryModelImpl.

      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.product.model.impl.CPConfigurationEntryModelImpl.

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

      public static CPConfigurationEntry fetchCPConfigurationEntry(long CPConfigurationEntryId)
    • fetchCPConfigurationEntry

      public static CPConfigurationEntry fetchCPConfigurationEntry(long classNameId, long classPK, long cpConfigurationListId)
    • fetchCPConfigurationEntryByExternalReferenceCode

      public static CPConfigurationEntry fetchCPConfigurationEntryByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchCPConfigurationEntryByUuidAndGroupId

      public static CPConfigurationEntry fetchCPConfigurationEntryByUuidAndGroupId(String uuid, long groupId)
      Returns the cp configuration entry matching the UUID and group.
      Parameters:
      uuid - the cp configuration entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching cp configuration entry, or null if a matching cp configuration entry could not be found
    • forceDeleteCPConfigurationEntry

      public static CPConfigurationEntry forceDeleteCPConfigurationEntry(CPConfigurationEntry cpConfigurationEntry)
    • getActionableDynamicQuery

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

      public static List<CPConfigurationEntry> getCPConfigurationEntries(int start, int end)
      Returns a range of all the cp configuration entries.

      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.product.model.impl.CPConfigurationEntryModelImpl.

      Parameters:
      start - the lower bound of the range of cp configuration entries
      end - the upper bound of the range of cp configuration entries (not inclusive)
      Returns:
      the range of cp configuration entries
    • getCPConfigurationEntries

      public static List<CPConfigurationEntry> getCPConfigurationEntries(long cpConfigurationListId)
    • getCPConfigurationEntries

      public static List<CPConfigurationEntry> getCPConfigurationEntries(long classNameId, long classPK)
    • getCPConfigurationEntries

      public static List<CPConfigurationEntry> getCPConfigurationEntries(long classNameId, long classPK, boolean visible)
    • getCPConfigurationEntriesByUuidAndCompanyId

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

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

      public static int getCPConfigurationEntriesCount()
      Returns the number of cp configuration entries.
      Returns:
      the number of cp configuration entries
    • getCPConfigurationEntry

      public static CPConfigurationEntry getCPConfigurationEntry(long CPConfigurationEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the cp configuration entry with the primary key.
      Parameters:
      CPConfigurationEntryId - the primary key of the cp configuration entry
      Returns:
      the cp configuration entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a cp configuration entry with the primary key could not be found
    • getCPConfigurationEntry

      public static CPConfigurationEntry getCPConfigurationEntry(long classNameId, long classPK, long cpConfigurationListId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCPConfigurationEntryByExternalReferenceCode

      public static CPConfigurationEntry getCPConfigurationEntryByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCPConfigurationEntryByUuidAndGroupId

      public static CPConfigurationEntry getCPConfigurationEntryByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the cp configuration entry matching the UUID and group.
      Parameters:
      uuid - the cp configuration entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching cp configuration entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching cp configuration entry could not be found
    • 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
    • updateCPConfigurationEntry

      public static CPConfigurationEntry updateCPConfigurationEntry(CPConfigurationEntry cpConfigurationEntry)
      Updates the cp configuration entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CPConfigurationEntryLocalServiceImpl 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:
      cpConfigurationEntry - the cp configuration entry
      Returns:
      the cp configuration entry that was updated
    • updateCPConfigurationEntry

      public static CPConfigurationEntry updateCPConfigurationEntry(String externalReferenceCode, long cpConfigurationEntryId, long cpTaxCategoryId, String allowedOrderQuantities, boolean backOrders, long commerceAvailabilityEstimateId, String cpDefinitionInventoryEngine, double depth, boolean displayAvailability, boolean displayStockQuantity, boolean freeShipping, double height, String lowStockActivity, BigDecimal maxOrderQuantity, BigDecimal minOrderQuantity, BigDecimal minStockQuantity, BigDecimal multipleOrderQuantity, boolean purchasable, boolean shippable, double shippingExtraPrice, boolean shipSeparately, boolean taxExempt, boolean visible, double weight, double width) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static CPConfigurationEntryLocalService getService()