Interface CPConfigurationEntryLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<CPConfigurationEntry>, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
CPConfigurationEntryLocalServiceWrapper

@CTAware @ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface CPConfigurationEntryLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<CPConfigurationEntry>, com.liferay.portal.kernel.service.PersistedModelLocalService
Provides the local service interface for CPConfigurationEntry. 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:
  • Method Details

    • addCPConfigurationEntry

      @Indexable(type=REINDEX) 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

      @Indexable(type=REINDEX) 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

      @Transactional(enabled=false) 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

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCPConfigurationEntries

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

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

      @Indexable(type=DELETE) 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

      @Indexable(type=DELETE) 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

      com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) CPConfigurationEntry fetchCPConfigurationEntry(long CPConfigurationEntryId)
    • fetchCPConfigurationEntry

      @Transactional(propagation=SUPPORTS, readOnly=true) CPConfigurationEntry fetchCPConfigurationEntry(long classNameId, long classPK, long cpConfigurationListId)
    • fetchCPConfigurationEntryByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) CPConfigurationEntry fetchCPConfigurationEntryByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchCPConfigurationEntryByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      CPConfigurationEntry forceDeleteCPConfigurationEntry(CPConfigurationEntry cpConfigurationEntry)
    • getActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getCPConfigurationEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CPConfigurationEntry> getCPConfigurationEntries(long cpConfigurationListId)
    • getCPConfigurationEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CPConfigurationEntry> getCPConfigurationEntries(long classNameId, long classPK)
    • getCPConfigurationEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CPConfigurationEntry> getCPConfigurationEntries(long classNameId, long classPK, boolean visible)
    • getCPConfigurationEntriesByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getCPConfigurationEntriesCount()
      Returns the number of cp configuration entries.
      Returns:
      the number of cp configuration entries
    • getCPConfigurationEntry

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) CPConfigurationEntry getCPConfigurationEntry(long classNameId, long classPK, long cpConfigurationListId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCPConfigurationEntryByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) CPConfigurationEntry getCPConfigurationEntryByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCPConfigurationEntryByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCPConfigurationEntry

      @Indexable(type=REINDEX) 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

      @Indexable(type=REINDEX) 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
    • getCTPersistence

      @Transactional(enabled=false) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<CPConfigurationEntry> getCTPersistence()
      Specified by:
      getCTPersistence in interface com.liferay.portal.kernel.service.change.tracking.CTService<CPConfigurationEntry>
    • getModelClass

      @Transactional(enabled=false) Class<CPConfigurationEntry> getModelClass()
      Specified by:
      getModelClass in interface com.liferay.portal.kernel.service.change.tracking.CTService<CPConfigurationEntry>
    • updateWithUnsafeFunction

      @Transactional(rollbackFor=java.lang.Throwable.class) <R, E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<CPConfigurationEntry>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface com.liferay.portal.kernel.service.change.tracking.CTService<CPConfigurationEntry>
      Throws:
      E extends Throwable