Interface CommerceChannelLocalService

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

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

    • addCommerceChannel

      @Indexable(type=REINDEX) CommerceChannel addCommerceChannel(CommerceChannel commerceChannel)
      Adds the commerce channel to the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceChannelLocalServiceImpl 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:
      commerceChannel - the commerce channel
      Returns:
      the commerce channel that was added
    • addCommerceChannel

      @Indexable(type=REINDEX) CommerceChannel addCommerceChannel(String externalReferenceCode, long accountEntryId, long siteGroupId, String name, String type, com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties, String commerceCurrencyCode, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOrUpdateCommerceChannel

      @Indexable(type=REINDEX) CommerceChannel addOrUpdateCommerceChannel(long userId, String externalReferenceCode, long accountEntryId, long siteGroupId, String name, String type, com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties, String commerceCurrencyCode, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createCommerceChannel

      @Transactional(enabled=false) CommerceChannel createCommerceChannel(long commerceChannelId)
      Creates a new commerce channel with the primary key. Does not add the commerce channel to the database.
      Parameters:
      commerceChannelId - the primary key for the new commerce channel
      Returns:
      the new commerce channel
    • 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
    • deleteCommerceChannel

      @Indexable(type=DELETE) @SystemEvent(type=1) CommerceChannel deleteCommerceChannel(CommerceChannel commerceChannel) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the commerce channel from the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceChannelLocalServiceImpl 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:
      commerceChannel - the commerce channel
      Returns:
      the commerce channel that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCommerceChannel

      @Indexable(type=DELETE) CommerceChannel deleteCommerceChannel(long commerceChannelId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the commerce channel with the primary key from the database. Also notifies the appropriate model listeners.

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

      void deleteCommerceChannels(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.CommerceChannelModelImpl.

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceChannel fetchCommerceChannel(long commerceChannelId)
    • fetchCommerceChannelByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceChannel fetchCommerceChannelByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchCommerceChannelByGroupClassPK

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceChannel fetchCommerceChannelByGroupClassPK(long groupId)
    • fetchCommerceChannelBySiteGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceChannel fetchCommerceChannelBySiteGroupId(long siteGroupId)
    • fetchCommerceChannelByUuidAndCompanyId

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

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.Group fetchCommerceChannelGroup(long commerceChannelId) 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()
    • getCommerceChannel

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceChannel getCommerceChannel(long commerceChannelId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the commerce channel with the primary key.
      Parameters:
      commerceChannelId - the primary key of the commerce channel
      Returns:
      the commerce channel
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a commerce channel with the primary key could not be found
    • getCommerceChannelByExternalReferenceCode

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

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceChannel getCommerceChannelByGroupId(long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceChannelByOrderGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceChannel getCommerceChannelByOrderGroupId(long orderGroupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceChannelByUuidAndCompanyId

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) long getCommerceChannelGroupIdBySiteGroupId(long siteGroupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceChannels

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

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

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CommerceChannel> getCommerceChannels(long companyId, String keywords, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceChannelsByAccountEntryId

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CommerceChannel> getCommerceChannelsByAccountEntryId(long accountEntryId)
    • getCommerceChannelsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getCommerceChannelsCount()
      Returns the number of commerce channels.
      Returns:
      the number of commerce channels
    • getCommerceChannelsCount

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CommerceChannel> getEligibleCommerceChannels(long accountEntryId, String name, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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<CommerceChannel> search(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • search

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

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

      @Indexable(type=REINDEX) CommerceChannel updateCommerceChannel(CommerceChannel commerceChannel)
      Updates the commerce channel in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CommerceChannelLocalServiceImpl 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:
      commerceChannel - the commerce channel
      Returns:
      the commerce channel that was updated
    • updateCommerceChannel

      @Indexable(type=REINDEX) CommerceChannel updateCommerceChannel(long commerceChannelId, long accountEntryId, long siteGroupId, String name, String type, com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties, String commerceCurrencyCode, String priceDisplayType, boolean discountsTargetNetPrice) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCommerceChannelExternalReferenceCode

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

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