Class CommerceTermEntryLocalServiceUtil

java.lang.Object
com.liferay.commerce.term.service.CommerceTermEntryLocalServiceUtil

public class CommerceTermEntryLocalServiceUtil extends Object
Provides the local service utility for CommerceTermEntry. This utility wraps com.liferay.commerce.term.service.impl.CommerceTermEntryLocalServiceImpl 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

    • CommerceTermEntryLocalServiceUtil

      public CommerceTermEntryLocalServiceUtil()
  • Method Details

    • addCommerceTermEntry

      public static CommerceTermEntry addCommerceTermEntry(CommerceTermEntry commerceTermEntry)
      Adds the commerce term entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceTermEntryLocalServiceImpl 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:
      commerceTermEntry - the commerce term entry
      Returns:
      the commerce term entry that was added
    • addCommerceTermEntry

      public static CommerceTermEntry addCommerceTermEntry(String externalReferenceCode, long userId, boolean active, Map<Locale,String> descriptionMap, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, Map<Locale,String> labelMap, String name, double priority, String type, String typeSettings, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • checkCommerceTermEntries

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

      public static CommerceTermEntry createCommerceTermEntry(long commerceTermEntryId)
      Creates a new commerce term entry with the primary key. Does not add the commerce term entry to the database.
      Parameters:
      commerceTermEntryId - the primary key for the new commerce term entry
      Returns:
      the new commerce term entry
    • 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
    • deleteCommerceTermEntry

      public static CommerceTermEntry deleteCommerceTermEntry(CommerceTermEntry commerceTermEntry) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the commerce term entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceTermEntryLocalServiceImpl 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:
      commerceTermEntry - the commerce term entry
      Returns:
      the commerce term entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCommerceTermEntry

      public static CommerceTermEntry deleteCommerceTermEntry(long commerceTermEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the commerce term entry with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceTermEntryLocalServiceImpl 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:
      commerceTermEntryId - the primary key of the commerce term entry
      Returns:
      the commerce term entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a commerce term entry 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.term.model.impl.CommerceTermEntryModelImpl.

      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.term.model.impl.CommerceTermEntryModelImpl.

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

      public static CommerceTermEntry fetchCommerceTermEntry(long commerceTermEntryId)
    • fetchCommerceTermEntryByExternalReferenceCode

      public static CommerceTermEntry fetchCommerceTermEntryByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchCommerceTermEntryByUuidAndCompanyId

      public static CommerceTermEntry fetchCommerceTermEntryByUuidAndCompanyId(String uuid, long companyId)
      Returns the commerce term entry with the matching UUID and company.
      Parameters:
      uuid - the commerce term entry's UUID
      companyId - the primary key of the company
      Returns:
      the matching commerce term entry, or null if a matching commerce term entry could not be found
    • fetchCTermEntryLocalization

      public static CTermEntryLocalization fetchCTermEntryLocalization(long commerceTermEntryId, String languageId)
    • getActionableDynamicQuery

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

      public static List<CommerceTermEntry> getCommerceTermEntries(int start, int end)
      Returns a range of all the commerce term 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.term.model.impl.CommerceTermEntryModelImpl.

      Parameters:
      start - the lower bound of the range of commerce term entries
      end - the upper bound of the range of commerce term entries (not inclusive)
      Returns:
      the range of commerce term entries
    • getCommerceTermEntries

      public static List<CommerceTermEntry> getCommerceTermEntries(long companyId, String type)
    • getCommerceTermEntriesCount

      public static int getCommerceTermEntriesCount()
      Returns the number of commerce term entries.
      Returns:
      the number of commerce term entries
    • getCommerceTermEntry

      public static CommerceTermEntry getCommerceTermEntry(long commerceTermEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the commerce term entry with the primary key.
      Parameters:
      commerceTermEntryId - the primary key of the commerce term entry
      Returns:
      the commerce term entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a commerce term entry with the primary key could not be found
    • getCommerceTermEntryByExternalReferenceCode

      public static CommerceTermEntry getCommerceTermEntryByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCommerceTermEntryByUuidAndCompanyId

      public static CommerceTermEntry getCommerceTermEntryByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the commerce term entry with the matching UUID and company.
      Parameters:
      uuid - the commerce term entry's UUID
      companyId - the primary key of the company
      Returns:
      the matching commerce term entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching commerce term entry could not be found
    • getCTermEntryLocalization

      public static CTermEntryLocalization getCTermEntryLocalization(long commerceTermEntryId, String languageId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCTermEntryLocalizationLanguageIds

      public static List<String> getCTermEntryLocalizationLanguageIds(long commerceTermEntryId)
    • getCTermEntryLocalizations

      public static List<CTermEntryLocalization> getCTermEntryLocalizations(long commerceTermEntryId)
    • getDeliveryCommerceTermEntries

      public static List<CommerceTermEntry> getDeliveryCommerceTermEntries(long companyId, long commerceOrderTypeId, long commerceShippingOptionId)
    • getDeliveryCommerceTermEntriesCount

      public static int getDeliveryCommerceTermEntriesCount(long companyId, long commerceOrderTypeId, long commerceShippingOptionId)
    • 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
    • getPaymentCommerceTermEntries

      public static List<CommerceTermEntry> getPaymentCommerceTermEntries(long companyId, long commerceOrderTypeId, long commercePaymentMethodGroupRelId)
    • getPaymentCommerceTermEntriesCount

      public static int getPaymentCommerceTermEntriesCount(long companyId, long commerceOrderTypeId, long commercePaymentMethodGroupRelId)
    • 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
    • search

      public static com.liferay.portal.kernel.search.Hits search(com.liferay.portal.kernel.search.SearchContext searchContext)
    • searchCommerceTermEntries

      public static com.liferay.portal.kernel.search.BaseModelSearchResult<CommerceTermEntry> searchCommerceTermEntries(long companyId, long accountEntryId, String type, 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
    • updateCommerceTermEntry

      public static CommerceTermEntry updateCommerceTermEntry(CommerceTermEntry commerceTermEntry)
      Updates the commerce term entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CommerceTermEntryLocalServiceImpl 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:
      commerceTermEntry - the commerce term entry
      Returns:
      the commerce term entry that was updated
    • updateCommerceTermEntry

      public static CommerceTermEntry updateCommerceTermEntry(long userId, long commerceTermEntryId, boolean active, Map<Locale,String> descriptionMap, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, Map<Locale,String> labelMap, String name, double priority, String typeSettings, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCommerceTermEntryExternalReferenceCode

      public static CommerceTermEntry updateCommerceTermEntryExternalReferenceCode(String externalReferenceCode, long commerceTermEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCTermEntryLocalization

      public static CTermEntryLocalization updateCTermEntryLocalization(CommerceTermEntry commerceTermEntry, String languageId, String description, String label) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCTermEntryLocalizations

      public static List<CTermEntryLocalization> updateCTermEntryLocalizations(CommerceTermEntry commerceTermEntry, Map<String,String> descriptionMap, Map<String,String> labelMap) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStatus

      public static CommerceTermEntry updateStatus(long userId, long commerceTermEntryId, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static CommerceTermEntryLocalService getService()