Class CommerceCurrencyLocalServiceUtil

java.lang.Object
com.liferay.commerce.currency.service.CommerceCurrencyLocalServiceUtil

public class CommerceCurrencyLocalServiceUtil extends Object
Provides the local service utility for CommerceCurrency. This utility wraps com.liferay.commerce.currency.service.impl.CommerceCurrencyLocalServiceImpl 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

    • CommerceCurrencyLocalServiceUtil

      public CommerceCurrencyLocalServiceUtil()
  • Method Details

    • addCommerceCurrency

      public static 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

      public static 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

      public static 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

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

      public static void deleteCommerceCurrencies(long companyId)
    • deleteCommerceCurrency

      public static 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

      public static 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

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

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

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

      public static CommerceCurrency fetchCommerceCurrency(long commerceCurrencyId)
    • fetchCommerceCurrency

      public static CommerceCurrency fetchCommerceCurrency(long companyId, String code)
    • fetchCommerceCurrencyByExternalReferenceCode

      public static CommerceCurrency fetchCommerceCurrencyByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchCommerceCurrencyByUuidAndCompanyId

      public static 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

      public static CommerceCurrency fetchPrimaryCommerceCurrency(long companyId)
    • getActionableDynamicQuery

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

      public static 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

      public static List<CommerceCurrency> getCommerceCurrencies(long companyId, boolean active)
    • getCommerceCurrencies

      public static List<CommerceCurrency> getCommerceCurrencies(long companyId, boolean active, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceCurrency> orderByComparator)
    • getCommerceCurrencies

      public static List<CommerceCurrency> getCommerceCurrencies(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceCurrency> orderByComparator)
    • getCommerceCurrenciesCount

      public static int getCommerceCurrenciesCount()
      Returns the number of commerce currencies.
      Returns:
      the number of commerce currencies
    • getCommerceCurrenciesCount

      public static int getCommerceCurrenciesCount(long companyId)
    • getCommerceCurrenciesCount

      public static int getCommerceCurrenciesCount(long companyId, boolean active)
    • getCommerceCurrency

      public static 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

      public static CommerceCurrency getCommerceCurrency(long companyId, String code) throws NoSuchCurrencyException
      Throws:
      NoSuchCurrencyException
    • getCommerceCurrencyByExternalReferenceCode

      public static CommerceCurrency getCommerceCurrencyByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceCurrencyByUuidAndCompanyId

      public static 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

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

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

      public static 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

      public static CommerceCurrency setActive(long commerceCurrencyId, boolean active) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • setPrimary

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

      public static 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

      public static 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

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

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

      public static void updateExchangeRates() throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static CommerceCurrencyLocalService getService()