Class CommercePaymentEntryLocalServiceUtil

java.lang.Object
com.liferay.commerce.payment.service.CommercePaymentEntryLocalServiceUtil

public class CommercePaymentEntryLocalServiceUtil extends Object
Provides the local service utility for CommercePaymentEntry. This utility wraps com.liferay.commerce.payment.service.impl.CommercePaymentEntryLocalServiceImpl 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

    • CommercePaymentEntryLocalServiceUtil

      public CommercePaymentEntryLocalServiceUtil()
  • Method Details

    • addCommercePaymentEntry

      public static CommercePaymentEntry addCommercePaymentEntry(CommercePaymentEntry commercePaymentEntry)
      Adds the commerce payment entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect CommercePaymentEntryLocalServiceImpl 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:
      commercePaymentEntry - the commerce payment entry
      Returns:
      the commerce payment entry that was added
    • addCommercePaymentEntry

      public static CommercePaymentEntry addCommercePaymentEntry(long userId, long classNameId, long classPK, long commerceChannelId, BigDecimal amount, String callbackURL, String cancelURL, String currencyCode, String languageId, String note, String payload, String paymentIntegrationKey, int paymentIntegrationType, String reasonKey, String transactionCode, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOrUpdateCommercePaymentEntry

      public static CommercePaymentEntry addOrUpdateCommercePaymentEntry(String externalReferenceCode, long userId, long classNameId, long classPK, long commerceChannelId, BigDecimal amount, String callbackURL, String cancelURL, String currencyCode, String errorMessages, String languageId, String note, String payload, String paymentIntegrationKey, int paymentIntegrationType, int paymentStatus, String reasonKey, String redirectURL, String transactionCode, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createCommercePaymentEntry

      public static CommercePaymentEntry createCommercePaymentEntry(long commercePaymentEntryId)
      Creates a new commerce payment entry with the primary key. Does not add the commerce payment entry to the database.
      Parameters:
      commercePaymentEntryId - the primary key for the new commerce payment entry
      Returns:
      the new commerce payment 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
    • deleteCommercePaymentEntries

      public static void deleteCommercePaymentEntries(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCommercePaymentEntry

      public static CommercePaymentEntry deleteCommercePaymentEntry(CommercePaymentEntry commercePaymentEntry) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the commerce payment entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect CommercePaymentEntryLocalServiceImpl 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:
      commercePaymentEntry - the commerce payment entry
      Returns:
      the commerce payment entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCommercePaymentEntry

      public static CommercePaymentEntry deleteCommercePaymentEntry(long commercePaymentEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the commerce payment entry with the primary key from the database. Also notifies the appropriate model listeners.

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

      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.payment.model.impl.CommercePaymentEntryModelImpl.

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

      public static CommercePaymentEntry fetchCommercePaymentEntry(long commercePaymentEntryId)
    • fetchCommercePaymentEntryByExternalReferenceCode

      public static CommercePaymentEntry fetchCommercePaymentEntryByExternalReferenceCode(String externalReferenceCode, long companyId)
    • getActionableDynamicQuery

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

      public static List<CommercePaymentEntry> getCommercePaymentEntries(int start, int end)
      Returns a range of all the commerce payment 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.payment.model.impl.CommercePaymentEntryModelImpl.

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

      public static List<CommercePaymentEntry> getCommercePaymentEntries(long companyId, long classNameId, long classPK, int type, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommercePaymentEntry> orderByComparator)
    • getCommercePaymentEntries

      public static List<CommercePaymentEntry> getCommercePaymentEntries(long companyId, long classNameId, long classPK, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommercePaymentEntry> orderByComparator)
    • getCommercePaymentEntriesCount

      public static int getCommercePaymentEntriesCount()
      Returns the number of commerce payment entries.
      Returns:
      the number of commerce payment entries
    • getCommercePaymentEntriesCount

      public static int getCommercePaymentEntriesCount(long companyId, long classNameId, long classPK)
    • getCommercePaymentEntriesCount

      public static int getCommercePaymentEntriesCount(long companyId, long classNameId, long classPK, int type)
    • getCommercePaymentEntry

      public static CommercePaymentEntry getCommercePaymentEntry(long commercePaymentEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the commerce payment entry with the primary key.
      Parameters:
      commercePaymentEntryId - the primary key of the commerce payment entry
      Returns:
      the commerce payment entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a commerce payment entry with the primary key could not be found
    • getCommercePaymentEntryByExternalReferenceCode

      public static CommercePaymentEntry getCommercePaymentEntryByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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
    • getRefundCommercePaymentEntries

      public static List<CommercePaymentEntry> getRefundCommercePaymentEntries(long companyId, long classNameId, long classPK, int start, int end)
    • getRefundCommercePaymentEntriesCount

      public static int getRefundCommercePaymentEntriesCount(long companyId, long classNameId, long classPK)
    • getRefundedAmount

      public static BigDecimal getRefundedAmount(long companyId, long classNameId, long classPK)
    • searchCommercePaymentEntries

      public static com.liferay.portal.kernel.search.BaseModelSearchResult<CommercePaymentEntry> searchCommercePaymentEntries(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, com.liferay.portal.kernel.search.Sort sort)
    • updateCommercePaymentEntry

      public static CommercePaymentEntry updateCommercePaymentEntry(CommercePaymentEntry commercePaymentEntry)
      Updates the commerce payment entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CommercePaymentEntryLocalServiceImpl 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:
      commercePaymentEntry - the commerce payment entry
      Returns:
      the commerce payment entry that was updated
    • updateCommercePaymentEntry

      public static CommercePaymentEntry updateCommercePaymentEntry(String externalReferenceCode, long commercePaymentEntryId, long commerceChannelId, BigDecimal amount, String callbackURL, String cancelURL, String currencyCode, String errorMessages, String languageId, String note, String payload, String paymentIntegrationKey, int paymentIntegrationType, int paymentStatus, String reasonKey, String redirectURL, String transactionCode, int type) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateExternalReferenceCode

      public static CommercePaymentEntry updateExternalReferenceCode(long commercePaymentEntryId, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateNote

      public static CommercePaymentEntry updateNote(long commercePaymentEntryId, String note) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateReasonKey

      public static CommercePaymentEntry updateReasonKey(long commercePaymentEntryId, String reasonKey) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static CommercePaymentEntryLocalService getService()