Interface CommerceCatalogLocalService

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

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

    • addCommerceCatalog

      @Indexable(type=REINDEX) CommerceCatalog addCommerceCatalog(CommerceCatalog commerceCatalog)
      Adds the commerce catalog to the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceCatalogLocalServiceImpl 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:
      commerceCatalog - the commerce catalog
      Returns:
      the commerce catalog that was added
    • addCommerceCatalog

      @Indexable(type=REINDEX) CommerceCatalog addCommerceCatalog(String externalReferenceCode, long accountEntryId, String name, String commerceCurrencyCode, String catalogDefaultLanguageId, boolean system, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addCommerceCatalog

      CommerceCatalog addCommerceCatalog(String externalReferenceCode, String name, String commerceCurrencyCode, String catalogDefaultLanguageId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addDefaultCommerceCatalog

      CommerceCatalog addDefaultCommerceCatalog(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createCommerceCatalog

      @Transactional(enabled=false) CommerceCatalog createCommerceCatalog(long commerceCatalogId)
      Creates a new commerce catalog with the primary key. Does not add the commerce catalog to the database.
      Parameters:
      commerceCatalogId - the primary key for the new commerce catalog
      Returns:
      the new commerce catalog
    • 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
    • deleteCommerceCatalog

      @Indexable(type=DELETE) @SystemEvent(type=1) CommerceCatalog deleteCommerceCatalog(CommerceCatalog commerceCatalog) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the commerce catalog from the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceCatalogLocalServiceImpl 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:
      commerceCatalog - the commerce catalog
      Returns:
      the commerce catalog that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCommerceCatalog

      @Indexable(type=DELETE) CommerceCatalog deleteCommerceCatalog(long commerceCatalogId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the commerce catalog with the primary key from the database. Also notifies the appropriate model listeners.

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

      void deleteCommerceCatalogs(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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.CommerceCatalogModelImpl.

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceCatalog fetchCommerceCatalog(long commerceCatalogId)
    • fetchCommerceCatalogByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceCatalog fetchCommerceCatalogByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchCommerceCatalogByGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceCatalog fetchCommerceCatalogByGroupId(long groupId)
    • fetchCommerceCatalogByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceCatalog fetchCommerceCatalogByUuidAndCompanyId(String uuid, long companyId)
      Returns the commerce catalog with the matching UUID and company.
      Parameters:
      uuid - the commerce catalog's UUID
      companyId - the primary key of the company
      Returns:
      the matching commerce catalog, or null if a matching commerce catalog could not be found
    • forceDeleteCommerceCatalog

      @Indexable(type=DELETE) @SystemEvent(type=1) CommerceCatalog forceDeleteCommerceCatalog(CommerceCatalog commerceCatalog) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getActionableDynamicQuery

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

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceCatalog getCommerceCatalog(long commerceCatalogId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the commerce catalog with the primary key.
      Parameters:
      commerceCatalogId - the primary key of the commerce catalog
      Returns:
      the commerce catalog
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a commerce catalog with the primary key could not be found
    • getCommerceCatalogByExternalReferenceCode

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

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceCatalog getCommerceCatalogByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the commerce catalog with the matching UUID and company.
      Parameters:
      uuid - the commerce catalog's UUID
      companyId - the primary key of the company
      Returns:
      the matching commerce catalog
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching commerce catalog could not be found
    • getCommerceCatalogGroup

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.Group getCommerceCatalogGroup(long commerceCatalogId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceCatalogs

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CommerceCatalog> getCommerceCatalogs(int start, int end)
      Returns a range of all the commerce catalogs.

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CommerceCatalog> getCommerceCatalogs(long companyId)
    • getCommerceCatalogs

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CommerceCatalog> getCommerceCatalogs(long companyId, boolean system)
    • getCommerceCatalogsByAccountEntryId

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CommerceCatalog> getCommerceCatalogsByAccountEntryId(long accountEntryId)
    • getCommerceCatalogsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getCommerceCatalogsCount()
      Returns the number of commerce catalogs.
      Returns:
      the number of commerce catalogs
    • 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
    • search

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CommerceCatalog> search(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • search

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CommerceCatalog> search(long companyId, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • searchCommerceCatalogsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int searchCommerceCatalogsCount(long companyId, String keywords) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCommerceCatalog

      @Indexable(type=REINDEX) CommerceCatalog updateCommerceCatalog(CommerceCatalog commerceCatalog)
      Updates the commerce catalog in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CommerceCatalogLocalServiceImpl 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:
      commerceCatalog - the commerce catalog
      Returns:
      the commerce catalog that was updated
    • updateCommerceCatalog

      @Indexable(type=REINDEX) CommerceCatalog updateCommerceCatalog(long commerceCatalogId, long accountEntryId, String name, String commerceCurrencyCode, String catalogDefaultLanguageId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCommerceCatalogExternalReferenceCode

      @Indexable(type=REINDEX) CommerceCatalog updateCommerceCatalogExternalReferenceCode(String externalReferenceCode, long commerceCatalogId) 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<CommerceCatalog> getCTPersistence()
      Specified by:
      getCTPersistence in interface com.liferay.portal.kernel.service.change.tracking.CTService<CommerceCatalog>
    • getModelClass

      @Transactional(enabled=false) Class<CommerceCatalog> getModelClass()
      Specified by:
      getModelClass in interface com.liferay.portal.kernel.service.change.tracking.CTService<CommerceCatalog>
    • 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<CommerceCatalog>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface com.liferay.portal.kernel.service.change.tracking.CTService<CommerceCatalog>
      Throws:
      E extends Throwable