com.liferay.commerce.service.CommerceSubscriptionEntryLocalService Maven / Gradle / Ivy
/**
* SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
* SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
*/
package com.liferay.commerce.service;
import com.liferay.commerce.model.CommerceSubscriptionEntry;
import com.liferay.exportimport.kernel.lar.PortletDataContext;
import com.liferay.petra.sql.dsl.query.DSLQuery;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.Projection;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.search.BaseModelSearchResult;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.search.Sort;
import com.liferay.portal.kernel.service.BaseLocalService;
import com.liferay.portal.kernel.service.PersistedModelLocalService;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import com.liferay.portal.kernel.util.UnicodeProperties;
import java.io.Serializable;
import java.util.Date;
import java.util.List;
import org.osgi.annotation.versioning.ProviderType;
/**
* 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.
*
* @author Alessio Antonio Rendina
* @see CommerceSubscriptionEntryLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface CommerceSubscriptionEntryLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.commerce.service.impl.CommerceSubscriptionEntryLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the commerce subscription entry local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link CommerceSubscriptionEntryLocalServiceUtil} if injection and service tracking are not available.
*/
/**
* 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.
*
*
* @param commerceSubscriptionEntry the commerce subscription entry
* @return the commerce subscription entry that was added
*/
@Indexable(type = IndexableType.REINDEX)
public CommerceSubscriptionEntry addCommerceSubscriptionEntry(
CommerceSubscriptionEntry commerceSubscriptionEntry);
/**
* @deprecated As of Athanasius (7.3.x)
*/
@Deprecated
public CommerceSubscriptionEntry addCommerceSubscriptionEntry(
long userId, long groupId, long commerceOrderItemId,
int subscriptionLength, String subscriptionType,
long maxSubscriptionCycles,
UnicodeProperties subscriptionTypeSettingsUnicodeProperties)
throws PortalException;
@Indexable(type = IndexableType.REINDEX)
public CommerceSubscriptionEntry addCommerceSubscriptionEntry(
long userId, long groupId, long commerceOrderItemId,
int subscriptionLength, String subscriptionType,
long maxSubscriptionCycles,
UnicodeProperties subscriptionTypeSettingsUnicodeProperties,
int deliverySubscriptionLength, String deliverySubscriptionType,
long deliveryMaxSubscriptionCycles,
UnicodeProperties deliverySubscriptionTypeSettingsUnicodeProperties)
throws PortalException;
/**
* Creates a new commerce subscription entry with the primary key. Does not add the commerce subscription entry to the database.
*
* @param commerceSubscriptionEntryId the primary key for the new commerce subscription entry
* @return the new commerce subscription entry
*/
@Transactional(enabled = false)
public CommerceSubscriptionEntry createCommerceSubscriptionEntry(
long commerceSubscriptionEntryId);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
public void deleteCommerceSubscriptionEntries(long groupId);
/**
* 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.
*
*
* @param commerceSubscriptionEntry the commerce subscription entry
* @return the commerce subscription entry that was removed
*/
@Indexable(type = IndexableType.DELETE)
public CommerceSubscriptionEntry deleteCommerceSubscriptionEntry(
CommerceSubscriptionEntry commerceSubscriptionEntry);
/**
* 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.
*
*
* @param commerceSubscriptionEntryId the primary key of the commerce subscription entry
* @return the commerce subscription entry that was removed
* @throws PortalException if a commerce subscription entry with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public CommerceSubscriptionEntry deleteCommerceSubscriptionEntry(
long commerceSubscriptionEntryId)
throws PortalException;
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public T dslQuery(DSLQuery dslQuery);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int dslQueryCount(DSLQuery dslQuery);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(DynamicQuery dynamicQuery);
/**
* 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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end);
/**
* 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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(DynamicQuery dynamicQuery);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(
DynamicQuery dynamicQuery, Projection projection);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CommerceSubscriptionEntry fetchCommerceSubscriptionEntry(
long commerceSubscriptionEntryId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CommerceSubscriptionEntry
fetchCommerceSubscriptionEntryByCommerceOrderItemId(
long commerceOrderItemId);
/**
* Returns the commerce subscription entry matching the UUID and group.
*
* @param uuid the commerce subscription entry's UUID
* @param groupId the primary key of the group
* @return the matching commerce subscription entry, or null if a matching commerce subscription entry could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CommerceSubscriptionEntry
fetchCommerceSubscriptionEntryByUuidAndGroupId(
String uuid, long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List
getActiveCommerceSubscriptionEntries();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getActiveCommerceSubscriptionEntries(
long commerceAccountId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List
getCommerceDeliverySubscriptionEntriesToRenew();
/**
* 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.
*
*
* @param start the lower bound of the range of commerce subscription entries
* @param end the upper bound of the range of commerce subscription entries (not inclusive)
* @return the range of commerce subscription entries
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCommerceSubscriptionEntries(
int start, int end);
/**
* @deprecated As of Athanasius (7.3.x)
*/
@Deprecated
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCommerceSubscriptionEntries(
long companyId, long userId, int start, int end,
OrderByComparator orderByComparator);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCommerceSubscriptionEntries(
long companyId, long groupId, long userId, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns all the commerce subscription entries matching the UUID and company.
*
* @param uuid the UUID of the commerce subscription entries
* @param companyId the primary key of the company
* @return the matching commerce subscription entries, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List
getCommerceSubscriptionEntriesByUuidAndCompanyId(
String uuid, long companyId);
/**
* Returns a range of commerce subscription entries matching the UUID and company.
*
* @param uuid the UUID of the commerce subscription entries
* @param companyId the primary key of the company
* @param start the lower bound of the range of commerce subscription entries
* @param end the upper bound of the range of commerce subscription entries (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the range of matching commerce subscription entries, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List
getCommerceSubscriptionEntriesByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of commerce subscription entries.
*
* @return the number of commerce subscription entries
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getCommerceSubscriptionEntriesCount();
/**
* @deprecated As of Athanasius (7.3.x)
*/
@Deprecated
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getCommerceSubscriptionEntriesCount(long companyId, long userId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getCommerceSubscriptionEntriesCount(
long companyId, long groupId, long userId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List
getCommerceSubscriptionEntriesToRenew();
/**
* Returns the commerce subscription entry with the primary key.
*
* @param commerceSubscriptionEntryId the primary key of the commerce subscription entry
* @return the commerce subscription entry
* @throws PortalException if a commerce subscription entry with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CommerceSubscriptionEntry getCommerceSubscriptionEntry(
long commerceSubscriptionEntryId)
throws PortalException;
/**
* Returns the commerce subscription entry matching the UUID and group.
*
* @param uuid the commerce subscription entry's UUID
* @param groupId the primary key of the group
* @return the matching commerce subscription entry
* @throws PortalException if a matching commerce subscription entry could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CommerceSubscriptionEntry
getCommerceSubscriptionEntryByUuidAndGroupId(
String uuid, long groupId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
PortletDataContext portletDataContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
/**
* @throws PortalException
*/
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
public CommerceSubscriptionEntry
incrementCommerceDeliverySubscriptionEntryCycle(
long commerceSubscriptionEntryId)
throws PortalException;
public CommerceSubscriptionEntry incrementCommerceSubscriptionEntryCycle(
long commerceSubscriptionEntryId)
throws PortalException;
/**
* @deprecated As of Athanasius (7.3.x)
*/
@Deprecated
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public BaseModelSearchResult
searchCommerceSubscriptionEntries(
long companyId, Long maxSubscriptionCycles,
Integer subscriptionStatus, String keywords, int start, int end,
Sort sort)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public BaseModelSearchResult
searchCommerceSubscriptionEntries(
long companyId, long[] groupIds, Long maxSubscriptionCycles,
Integer subscriptionStatus, String keywords, int start, int end,
Sort sort)
throws PortalException;
/**
* 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.
*
*
* @param commerceSubscriptionEntry the commerce subscription entry
* @return the commerce subscription entry that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public CommerceSubscriptionEntry updateCommerceSubscriptionEntry(
CommerceSubscriptionEntry commerceSubscriptionEntry);
/**
* @deprecated As of Athanasius (7.3.x)
*/
@Deprecated
public CommerceSubscriptionEntry updateCommerceSubscriptionEntry(
long commerceSubscriptionEntryId, int subscriptionLength,
String subscriptionType,
UnicodeProperties subscriptionTypeSettingsUnicodeProperties,
long maxSubscriptionCycles, int subscriptionStatus,
int nextIterationDateMonth, int nextIterationDateDay,
int nextIterationDateYear, int nextIterationDateHour,
int nextIterationDateMinute)
throws PortalException;
@Indexable(type = IndexableType.REINDEX)
public CommerceSubscriptionEntry updateCommerceSubscriptionEntry(
long commerceSubscriptionEntryId, int subscriptionLength,
String subscriptionType,
UnicodeProperties subscriptionTypeSettingsUnicodeProperties,
long maxSubscriptionCycles, int subscriptionStatus,
int nextIterationDateMonth, int nextIterationDateDay,
int nextIterationDateYear, int nextIterationDateHour,
int nextIterationDateMinute, int deliverySubscriptionLength,
String deliverySubscriptionType,
UnicodeProperties deliverySubscriptionTypeSettingsUnicodeProperties,
long deliveryMaxSubscriptionCycles, int deliverySubscriptionStatus,
int deliveryNextIterationDateMonth,
int deliveryNextIterationDateDay, int deliveryNextIterationDateYear,
int deliveryNextIterationDateHour,
int deliveryNextIterationDateMinute)
throws PortalException;
/**
* @deprecated As of Athanasius (7.3.x)
*/
@Deprecated
public CommerceSubscriptionEntry
updateCommerceSubscriptionEntryIterationDates(
long commerceSubscriptionEntryId, Date lastIterationDate)
throws PortalException;
@Indexable(type = IndexableType.REINDEX)
public CommerceSubscriptionEntry updateDeliverySubscriptionStatus(
long commerceSubscriptionEntryId, int subscriptionStatus)
throws PortalException;
@Indexable(type = IndexableType.REINDEX)
public CommerceSubscriptionEntry updateSubscriptionStatus(
long commerceSubscriptionEntryId, int subscriptionStatus)
throws PortalException;
}