Class CommerceSubscriptionEntryLocalServiceUtil

java.lang.Object
com.liferay.commerce.service.CommerceSubscriptionEntryLocalServiceUtil

public class CommerceSubscriptionEntryLocalServiceUtil extends Object
Provides the local service utility for CommerceSubscriptionEntry. This utility wraps com.liferay.commerce.service.impl.CommerceSubscriptionEntryLocalServiceImpl 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

    • CommerceSubscriptionEntryLocalServiceUtil

      public CommerceSubscriptionEntryLocalServiceUtil()
  • Method Details

    • addCommerceSubscriptionEntry

      public static CommerceSubscriptionEntry addCommerceSubscriptionEntry(CommerceSubscriptionEntry commerceSubscriptionEntry)
      Adds the commerce subscription entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceSubscriptionEntryLocalServiceImpl 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:
      commerceSubscriptionEntry - the commerce subscription entry
      Returns:
      the commerce subscription entry that was added
    • addCommerceSubscriptionEntry

      @Deprecated public static CommerceSubscriptionEntry addCommerceSubscriptionEntry(long userId, long groupId, long commerceOrderItemId, int subscriptionLength, String subscriptionType, long maxSubscriptionCycles, com.liferay.portal.kernel.util.UnicodeProperties subscriptionTypeSettingsUnicodeProperties) throws com.liferay.portal.kernel.exception.PortalException
      Deprecated.
      As of Athanasius (7.3.x)
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addCommerceSubscriptionEntry

      public static CommerceSubscriptionEntry addCommerceSubscriptionEntry(long userId, long groupId, long commerceOrderItemId, int subscriptionLength, String subscriptionType, long maxSubscriptionCycles, com.liferay.portal.kernel.util.UnicodeProperties subscriptionTypeSettingsUnicodeProperties, int deliverySubscriptionLength, String deliverySubscriptionType, long deliveryMaxSubscriptionCycles, com.liferay.portal.kernel.util.UnicodeProperties deliverySubscriptionTypeSettingsUnicodeProperties) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createCommerceSubscriptionEntry

      public static CommerceSubscriptionEntry createCommerceSubscriptionEntry(long commerceSubscriptionEntryId)
      Creates a new commerce subscription entry with the primary key. Does not add the commerce subscription entry to the database.
      Parameters:
      commerceSubscriptionEntryId - the primary key for the new commerce subscription entry
      Returns:
      the new commerce subscription 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
    • deleteCommerceSubscriptionEntries

      public static void deleteCommerceSubscriptionEntries(long groupId)
    • deleteCommerceSubscriptionEntry

      public static CommerceSubscriptionEntry deleteCommerceSubscriptionEntry(CommerceSubscriptionEntry commerceSubscriptionEntry)
      Deletes the commerce subscription entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect CommerceSubscriptionEntryLocalServiceImpl 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:
      commerceSubscriptionEntry - the commerce subscription entry
      Returns:
      the commerce subscription entry that was removed
    • deleteCommerceSubscriptionEntry

      public static CommerceSubscriptionEntry deleteCommerceSubscriptionEntry(long commerceSubscriptionEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the commerce subscription entry with the primary key from the database. Also notifies the appropriate model listeners.

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

      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.model.impl.CommerceSubscriptionEntryModelImpl.

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

      public static CommerceSubscriptionEntry fetchCommerceSubscriptionEntry(long commerceSubscriptionEntryId)
    • fetchCommerceSubscriptionEntryByCommerceOrderItemId

      public static CommerceSubscriptionEntry fetchCommerceSubscriptionEntryByCommerceOrderItemId(long commerceOrderItemId)
    • fetchCommerceSubscriptionEntryByUuidAndGroupId

      public static CommerceSubscriptionEntry fetchCommerceSubscriptionEntryByUuidAndGroupId(String uuid, long groupId)
      Returns the commerce subscription entry matching the UUID and group.
      Parameters:
      uuid - the commerce subscription entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching commerce subscription entry, or null if a matching commerce subscription entry could not be found
    • getActionableDynamicQuery

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

      public static List<CommerceSubscriptionEntry> getActiveCommerceSubscriptionEntries()
    • getActiveCommerceSubscriptionEntries

      public static List<CommerceSubscriptionEntry> getActiveCommerceSubscriptionEntries(long commerceAccountId)
    • getCommerceDeliverySubscriptionEntriesToRenew

      public static List<CommerceSubscriptionEntry> getCommerceDeliverySubscriptionEntriesToRenew()
    • getCommerceSubscriptionEntries

      public static List<CommerceSubscriptionEntry> getCommerceSubscriptionEntries(int start, int end)
      Returns a range of all the commerce subscription 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.model.impl.CommerceSubscriptionEntryModelImpl.

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

      @Deprecated public static List<CommerceSubscriptionEntry> getCommerceSubscriptionEntries(long companyId, long userId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceSubscriptionEntry> orderByComparator)
      Deprecated.
      As of Athanasius (7.3.x)
    • getCommerceSubscriptionEntries

      public static List<CommerceSubscriptionEntry> getCommerceSubscriptionEntries(long companyId, long groupId, long userId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceSubscriptionEntry> orderByComparator)
    • getCommerceSubscriptionEntriesByUuidAndCompanyId

      public static List<CommerceSubscriptionEntry> getCommerceSubscriptionEntriesByUuidAndCompanyId(String uuid, long companyId)
      Returns all the commerce subscription entries matching the UUID and company.
      Parameters:
      uuid - the UUID of the commerce subscription entries
      companyId - the primary key of the company
      Returns:
      the matching commerce subscription entries, or an empty list if no matches were found
    • getCommerceSubscriptionEntriesByUuidAndCompanyId

      public static List<CommerceSubscriptionEntry> getCommerceSubscriptionEntriesByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceSubscriptionEntry> orderByComparator)
      Returns a range of commerce subscription entries matching the UUID and company.
      Parameters:
      uuid - the UUID of the commerce subscription entries
      companyId - the primary key of the company
      start - the lower bound of the range of commerce subscription entries
      end - the upper bound of the range of commerce subscription entries (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching commerce subscription entries, or an empty list if no matches were found
    • getCommerceSubscriptionEntriesCount

      public static int getCommerceSubscriptionEntriesCount()
      Returns the number of commerce subscription entries.
      Returns:
      the number of commerce subscription entries
    • getCommerceSubscriptionEntriesCount

      @Deprecated public static int getCommerceSubscriptionEntriesCount(long companyId, long userId)
      Deprecated.
      As of Athanasius (7.3.x)
    • getCommerceSubscriptionEntriesCount

      public static int getCommerceSubscriptionEntriesCount(long companyId, long groupId, long userId)
    • getCommerceSubscriptionEntriesToRenew

      public static List<CommerceSubscriptionEntry> getCommerceSubscriptionEntriesToRenew()
    • getCommerceSubscriptionEntry

      public static CommerceSubscriptionEntry getCommerceSubscriptionEntry(long commerceSubscriptionEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the commerce subscription entry with the primary key.
      Parameters:
      commerceSubscriptionEntryId - the primary key of the commerce subscription entry
      Returns:
      the commerce subscription entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a commerce subscription entry with the primary key could not be found
    • getCommerceSubscriptionEntryByUuidAndGroupId

      public static CommerceSubscriptionEntry getCommerceSubscriptionEntryByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the commerce subscription entry matching the UUID and group.
      Parameters:
      uuid - the commerce subscription entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching commerce subscription entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching commerce subscription entry 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
    • incrementCommerceDeliverySubscriptionEntryCycle

      public static CommerceSubscriptionEntry incrementCommerceDeliverySubscriptionEntryCycle(long commerceSubscriptionEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • incrementCommerceSubscriptionEntryCycle

      public static CommerceSubscriptionEntry incrementCommerceSubscriptionEntryCycle(long commerceSubscriptionEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • searchCommerceSubscriptionEntries

      @Deprecated public static com.liferay.portal.kernel.search.BaseModelSearchResult<CommerceSubscriptionEntry> searchCommerceSubscriptionEntries(long companyId, Long maxSubscriptionCycles, Integer subscriptionStatus, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort) throws com.liferay.portal.kernel.exception.PortalException
      Deprecated.
      As of Athanasius (7.3.x)
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • searchCommerceSubscriptionEntries

      public static com.liferay.portal.kernel.search.BaseModelSearchResult<CommerceSubscriptionEntry> searchCommerceSubscriptionEntries(long companyId, long[] groupIds, Long maxSubscriptionCycles, Integer subscriptionStatus, 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
    • updateCommerceSubscriptionEntry

      public static CommerceSubscriptionEntry updateCommerceSubscriptionEntry(CommerceSubscriptionEntry commerceSubscriptionEntry)
      Updates the commerce subscription entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CommerceSubscriptionEntryLocalServiceImpl 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:
      commerceSubscriptionEntry - the commerce subscription entry
      Returns:
      the commerce subscription entry that was updated
    • updateCommerceSubscriptionEntry

      @Deprecated public static CommerceSubscriptionEntry updateCommerceSubscriptionEntry(long commerceSubscriptionEntryId, int subscriptionLength, String subscriptionType, com.liferay.portal.kernel.util.UnicodeProperties subscriptionTypeSettingsUnicodeProperties, long maxSubscriptionCycles, int subscriptionStatus, int nextIterationDateMonth, int nextIterationDateDay, int nextIterationDateYear, int nextIterationDateHour, int nextIterationDateMinute) throws com.liferay.portal.kernel.exception.PortalException
      Deprecated.
      As of Athanasius (7.3.x)
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCommerceSubscriptionEntry

      public static CommerceSubscriptionEntry updateCommerceSubscriptionEntry(long commerceSubscriptionEntryId, int subscriptionLength, String subscriptionType, com.liferay.portal.kernel.util.UnicodeProperties subscriptionTypeSettingsUnicodeProperties, long maxSubscriptionCycles, int subscriptionStatus, int nextIterationDateMonth, int nextIterationDateDay, int nextIterationDateYear, int nextIterationDateHour, int nextIterationDateMinute, int deliverySubscriptionLength, String deliverySubscriptionType, com.liferay.portal.kernel.util.UnicodeProperties deliverySubscriptionTypeSettingsUnicodeProperties, long deliveryMaxSubscriptionCycles, int deliverySubscriptionStatus, int deliveryNextIterationDateMonth, int deliveryNextIterationDateDay, int deliveryNextIterationDateYear, int deliveryNextIterationDateHour, int deliveryNextIterationDateMinute) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCommerceSubscriptionEntryIterationDates

      @Deprecated public static CommerceSubscriptionEntry updateCommerceSubscriptionEntryIterationDates(long commerceSubscriptionEntryId, Date lastIterationDate) throws com.liferay.portal.kernel.exception.PortalException
      Deprecated.
      As of Athanasius (7.3.x)
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateDeliverySubscriptionStatus

      public static CommerceSubscriptionEntry updateDeliverySubscriptionStatus(long commerceSubscriptionEntryId, int subscriptionStatus) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSubscriptionStatus

      public static CommerceSubscriptionEntry updateSubscriptionStatus(long commerceSubscriptionEntryId, int subscriptionStatus) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static CommerceSubscriptionEntryLocalService getService()