Interface CommerceCurrencyLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
CommerceCurrencyLocalServiceWrapper

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

    • addCommerceCurrency

      @Indexable(type=REINDEX) CommerceCurrency addCommerceCurrency(CommerceCurrency commerceCurrency)
      Adds the commerce currency to the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceCurrencyLocalServiceImpl 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:
      commerceCurrency - the commerce currency
      Returns:
      the commerce currency that was added
    • addCommerceCurrency

      @Indexable(type=REINDEX) CommerceCurrency addCommerceCurrency(String externalReferenceCode, long userId, String code, Map<Locale,String> nameMap, String symbol, BigDecimal rate, Map<Locale,String> formatPatternMap, int maxFractionDigits, int minFractionDigits, String roundingMode, boolean primary, double priority, boolean active) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createCommerceCurrency

      @Transactional(enabled=false) CommerceCurrency createCommerceCurrency(long commerceCurrencyId)
      Creates a new commerce currency with the primary key. Does not add the commerce currency to the database.
      Parameters:
      commerceCurrencyId - the primary key for the new commerce currency
      Returns:
      the new commerce currency
    • 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
    • deleteCommerceCurrencies

      void deleteCommerceCurrencies(long companyId)
    • deleteCommerceCurrency

      @Indexable(type=DELETE) @SystemEvent(type=1) CommerceCurrency deleteCommerceCurrency(CommerceCurrency commerceCurrency)
      Deletes the commerce currency from the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceCurrencyLocalServiceImpl 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:
      commerceCurrency - the commerce currency
      Returns:
      the commerce currency that was removed
    • deleteCommerceCurrency

      @Indexable(type=DELETE) CommerceCurrency deleteCommerceCurrency(long commerceCurrencyId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the commerce currency with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceCurrencyLocalServiceImpl 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:
      commerceCurrencyId - the primary key of the commerce currency
      Returns:
      the commerce currency that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a commerce currency 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.currency.model.impl.CommerceCurrencyModelImpl.

      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.currency.model.impl.CommerceCurrencyModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceCurrency fetchCommerceCurrency(long commerceCurrencyId)
    • fetchCommerceCurrency

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceCurrency fetchCommerceCurrency(long companyId, String code)
    • fetchCommerceCurrencyByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceCurrency fetchCommerceCurrencyByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchCommerceCurrencyByUuidAndCompanyId

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

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceCurrency fetchPrimaryCommerceCurrency(long companyId)
    • getActionableDynamicQuery

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

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

      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.currency.model.impl.CommerceCurrencyModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CommerceCurrency> getCommerceCurrencies(long companyId, boolean active)
    • getCommerceCurrencies

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CommerceCurrency> getCommerceCurrencies(long companyId, boolean active, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceCurrency> orderByComparator)
    • getCommerceCurrencies

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CommerceCurrency> getCommerceCurrencies(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceCurrency> orderByComparator)
    • getCommerceCurrenciesCount

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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getCommerceCurrenciesCount(long companyId)
    • getCommerceCurrenciesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getCommerceCurrenciesCount(long companyId, boolean active)
    • getCommerceCurrency

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

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceCurrency getCommerceCurrency(long companyId, String code) throws NoSuchCurrencyException
      Throws:
      NoSuchCurrencyException
    • getCommerceCurrencyByExternalReferenceCode

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

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceCurrency getCommerceCurrencyByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the commerce currency with the matching UUID and company.
      Parameters:
      uuid - the commerce currency's UUID
      companyId - the primary key of the company
      Returns:
      the matching commerce currency
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching commerce currency 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
    • importDefaultValues

      void importDefaultValues(boolean updateExchangeRate, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws Exception
      Throws:
      Exception
    • searchCommerceCurrencies

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.search.BaseModelSearchResult<CommerceCurrency> searchCommerceCurrencies(long companyId, String keywords, LinkedHashMap<String,Object> params, 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
    • setActive

      @Indexable(type=REINDEX) CommerceCurrency setActive(long commerceCurrencyId, boolean active) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • setPrimary

      CommerceCurrency setPrimary(long commerceCurrencyId, boolean primary) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCommerceCurrency

      @Indexable(type=REINDEX) CommerceCurrency updateCommerceCurrency(CommerceCurrency commerceCurrency)
      Updates the commerce currency in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CommerceCurrencyLocalServiceImpl 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:
      commerceCurrency - the commerce currency
      Returns:
      the commerce currency that was updated
    • updateCommerceCurrency

      @Indexable(type=REINDEX) CommerceCurrency updateCommerceCurrency(String externalReferenceCode, long commerceCurrencyId, Map<Locale,String> nameMap, String symbol, BigDecimal rate, Map<Locale,String> formatPatternMap, int maxFractionDigits, int minFractionDigits, String roundingMode, boolean primary, double priority, boolean active, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCommerceCurrencyRate

      CommerceCurrency updateCommerceCurrencyRate(long commerceCurrencyId, BigDecimal rate) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateExchangeRate

      void updateExchangeRate(long commerceCurrencyId, String exchangeRateProviderKey) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateExchangeRates

      void updateExchangeRates() throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException