Interface CommerceSubscriptionEntryLocalService

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

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

    • addCommerceSubscriptionEntry

      @Indexable(type=REINDEX) 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 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

      @Indexable(type=REINDEX) 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

      @Transactional(enabled=false) 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

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

      void deleteCommerceSubscriptionEntries(long groupId)
    • deleteCommerceSubscriptionEntry

      @Indexable(type=DELETE) 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

      @Indexable(type=DELETE) 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

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

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceSubscriptionEntry fetchCommerceSubscriptionEntry(long commerceSubscriptionEntryId)
    • fetchCommerceSubscriptionEntryByCommerceOrderItemId

      @Transactional(propagation=SUPPORTS, readOnly=true) CommerceSubscriptionEntry fetchCommerceSubscriptionEntryByCommerceOrderItemId(long commerceOrderItemId)
    • fetchCommerceSubscriptionEntryByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CommerceSubscriptionEntry> getActiveCommerceSubscriptionEntries()
    • getActiveCommerceSubscriptionEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CommerceSubscriptionEntry> getActiveCommerceSubscriptionEntries(long commerceAccountId)
    • getCommerceDeliverySubscriptionEntriesToRenew

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CommerceSubscriptionEntry> getCommerceDeliverySubscriptionEntriesToRenew()
    • getCommerceSubscriptionEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) 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 @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CommerceSubscriptionEntry> getCommerceSubscriptionEntries(long companyId, long groupId, long userId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceSubscriptionEntry> orderByComparator)
    • getCommerceSubscriptionEntriesByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getCommerceSubscriptionEntriesCount()
      Returns the number of commerce subscription entries.
      Returns:
      the number of commerce subscription entries
    • getCommerceSubscriptionEntriesCount

      @Deprecated @Transactional(propagation=SUPPORTS, readOnly=true) int getCommerceSubscriptionEntriesCount(long companyId, long userId)
      Deprecated.
      As of Athanasius (7.3.x)
    • getCommerceSubscriptionEntriesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getCommerceSubscriptionEntriesCount(long companyId, long groupId, long userId)
    • getCommerceSubscriptionEntriesToRenew

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CommerceSubscriptionEntry> getCommerceSubscriptionEntriesToRenew()
    • getCommerceSubscriptionEntry

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @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
    • incrementCommerceDeliverySubscriptionEntryCycle

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

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

      @Deprecated @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Indexable(type=REINDEX) 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 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

      @Indexable(type=REINDEX) 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 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

      @Indexable(type=REINDEX) CommerceSubscriptionEntry updateDeliverySubscriptionStatus(long commerceSubscriptionEntryId, int subscriptionStatus) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSubscriptionStatus

      @Indexable(type=REINDEX) CommerceSubscriptionEntry updateSubscriptionStatus(long commerceSubscriptionEntryId, int subscriptionStatus) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException