com.liferay.commerce.service.persistence.CommerceShippingMethodPersistence 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.persistence;
import com.liferay.commerce.exception.NoSuchShippingMethodException;
import com.liferay.commerce.model.CommerceShippingMethod;
import com.liferay.portal.kernel.service.persistence.BasePersistence;
import org.osgi.annotation.versioning.ProviderType;
/**
* The persistence interface for the commerce shipping method service.
*
*
* Caching information and settings can be found in portal.properties
*
*
* @author Alessio Antonio Rendina
* @see CommerceShippingMethodUtil
* @generated
*/
@ProviderType
public interface CommerceShippingMethodPersistence
extends BasePersistence {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link CommerceShippingMethodUtil} to access the commerce shipping method persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.
*/
/**
* Returns all the commerce shipping methods where groupId = ?.
*
* @param groupId the group ID
* @return the matching commerce shipping methods
*/
public java.util.List findByGroupId(long groupId);
/**
* Returns a range of all the commerce shipping methods where groupId = ?.
*
*
* 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 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 CommerceShippingMethodModelImpl.
*
*
* @param groupId the group ID
* @param start the lower bound of the range of commerce shipping methods
* @param end the upper bound of the range of commerce shipping methods (not inclusive)
* @return the range of matching commerce shipping methods
*/
public java.util.List findByGroupId(
long groupId, int start, int end);
/**
* Returns an ordered range of all the commerce shipping methods where groupId = ?.
*
*
* 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 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 CommerceShippingMethodModelImpl.
*
*
* @param groupId the group ID
* @param start the lower bound of the range of commerce shipping methods
* @param end the upper bound of the range of commerce shipping methods (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching commerce shipping methods
*/
public java.util.List findByGroupId(
long groupId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns an ordered range of all the commerce shipping methods where groupId = ?.
*
*
* 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 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 CommerceShippingMethodModelImpl.
*
*
* @param groupId the group ID
* @param start the lower bound of the range of commerce shipping methods
* @param end the upper bound of the range of commerce shipping methods (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @param useFinderCache whether to use the finder cache
* @return the ordered range of matching commerce shipping methods
*/
public java.util.List findByGroupId(
long groupId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator,
boolean useFinderCache);
/**
* Returns the first commerce shipping method in the ordered set where groupId = ?.
*
* @param groupId the group ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching commerce shipping method
* @throws NoSuchShippingMethodException if a matching commerce shipping method could not be found
*/
public CommerceShippingMethod findByGroupId_First(
long groupId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator)
throws NoSuchShippingMethodException;
/**
* Returns the first commerce shipping method in the ordered set where groupId = ?.
*
* @param groupId the group ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching commerce shipping method, or null if a matching commerce shipping method could not be found
*/
public CommerceShippingMethod fetchByGroupId_First(
long groupId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns the last commerce shipping method in the ordered set where groupId = ?.
*
* @param groupId the group ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching commerce shipping method
* @throws NoSuchShippingMethodException if a matching commerce shipping method could not be found
*/
public CommerceShippingMethod findByGroupId_Last(
long groupId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator)
throws NoSuchShippingMethodException;
/**
* Returns the last commerce shipping method in the ordered set where groupId = ?.
*
* @param groupId the group ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching commerce shipping method, or null if a matching commerce shipping method could not be found
*/
public CommerceShippingMethod fetchByGroupId_Last(
long groupId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns the commerce shipping methods before and after the current commerce shipping method in the ordered set where groupId = ?.
*
* @param commerceShippingMethodId the primary key of the current commerce shipping method
* @param groupId the group ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the previous, current, and next commerce shipping method
* @throws NoSuchShippingMethodException if a commerce shipping method with the primary key could not be found
*/
public CommerceShippingMethod[] findByGroupId_PrevAndNext(
long commerceShippingMethodId, long groupId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator)
throws NoSuchShippingMethodException;
/**
* Removes all the commerce shipping methods where groupId = ? from the database.
*
* @param groupId the group ID
*/
public void removeByGroupId(long groupId);
/**
* Returns the number of commerce shipping methods where groupId = ?.
*
* @param groupId the group ID
* @return the number of matching commerce shipping methods
*/
public int countByGroupId(long groupId);
/**
* Returns all the commerce shipping methods where groupId = ? and active = ?.
*
* @param groupId the group ID
* @param active the active
* @return the matching commerce shipping methods
*/
public java.util.List findByG_A(
long groupId, boolean active);
/**
* Returns a range of all the commerce shipping methods where groupId = ? and active = ?.
*
*
* 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 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 CommerceShippingMethodModelImpl.
*
*
* @param groupId the group ID
* @param active the active
* @param start the lower bound of the range of commerce shipping methods
* @param end the upper bound of the range of commerce shipping methods (not inclusive)
* @return the range of matching commerce shipping methods
*/
public java.util.List findByG_A(
long groupId, boolean active, int start, int end);
/**
* Returns an ordered range of all the commerce shipping methods where groupId = ? and active = ?.
*
*
* 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 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 CommerceShippingMethodModelImpl.
*
*
* @param groupId the group ID
* @param active the active
* @param start the lower bound of the range of commerce shipping methods
* @param end the upper bound of the range of commerce shipping methods (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching commerce shipping methods
*/
public java.util.List findByG_A(
long groupId, boolean active, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns an ordered range of all the commerce shipping methods where groupId = ? and active = ?.
*
*
* 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 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 CommerceShippingMethodModelImpl.
*
*
* @param groupId the group ID
* @param active the active
* @param start the lower bound of the range of commerce shipping methods
* @param end the upper bound of the range of commerce shipping methods (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @param useFinderCache whether to use the finder cache
* @return the ordered range of matching commerce shipping methods
*/
public java.util.List findByG_A(
long groupId, boolean active, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator,
boolean useFinderCache);
/**
* Returns the first commerce shipping method in the ordered set where groupId = ? and active = ?.
*
* @param groupId the group ID
* @param active the active
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching commerce shipping method
* @throws NoSuchShippingMethodException if a matching commerce shipping method could not be found
*/
public CommerceShippingMethod findByG_A_First(
long groupId, boolean active,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator)
throws NoSuchShippingMethodException;
/**
* Returns the first commerce shipping method in the ordered set where groupId = ? and active = ?.
*
* @param groupId the group ID
* @param active the active
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching commerce shipping method, or null if a matching commerce shipping method could not be found
*/
public CommerceShippingMethod fetchByG_A_First(
long groupId, boolean active,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns the last commerce shipping method in the ordered set where groupId = ? and active = ?.
*
* @param groupId the group ID
* @param active the active
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching commerce shipping method
* @throws NoSuchShippingMethodException if a matching commerce shipping method could not be found
*/
public CommerceShippingMethod findByG_A_Last(
long groupId, boolean active,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator)
throws NoSuchShippingMethodException;
/**
* Returns the last commerce shipping method in the ordered set where groupId = ? and active = ?.
*
* @param groupId the group ID
* @param active the active
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching commerce shipping method, or null if a matching commerce shipping method could not be found
*/
public CommerceShippingMethod fetchByG_A_Last(
long groupId, boolean active,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns the commerce shipping methods before and after the current commerce shipping method in the ordered set where groupId = ? and active = ?.
*
* @param commerceShippingMethodId the primary key of the current commerce shipping method
* @param groupId the group ID
* @param active the active
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the previous, current, and next commerce shipping method
* @throws NoSuchShippingMethodException if a commerce shipping method with the primary key could not be found
*/
public CommerceShippingMethod[] findByG_A_PrevAndNext(
long commerceShippingMethodId, long groupId, boolean active,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator)
throws NoSuchShippingMethodException;
/**
* Removes all the commerce shipping methods where groupId = ? and active = ? from the database.
*
* @param groupId the group ID
* @param active the active
*/
public void removeByG_A(long groupId, boolean active);
/**
* Returns the number of commerce shipping methods where groupId = ? and active = ?.
*
* @param groupId the group ID
* @param active the active
* @return the number of matching commerce shipping methods
*/
public int countByG_A(long groupId, boolean active);
/**
* Returns the commerce shipping method where groupId = ? and engineKey = ? or throws a NoSuchShippingMethodException if it could not be found.
*
* @param groupId the group ID
* @param engineKey the engine key
* @return the matching commerce shipping method
* @throws NoSuchShippingMethodException if a matching commerce shipping method could not be found
*/
public CommerceShippingMethod findByG_E(long groupId, String engineKey)
throws NoSuchShippingMethodException;
/**
* Returns the commerce shipping method where groupId = ? and engineKey = ? or returns null if it could not be found. Uses the finder cache.
*
* @param groupId the group ID
* @param engineKey the engine key
* @return the matching commerce shipping method, or null if a matching commerce shipping method could not be found
*/
public CommerceShippingMethod fetchByG_E(long groupId, String engineKey);
/**
* Returns the commerce shipping method where groupId = ? and engineKey = ? or returns null if it could not be found, optionally using the finder cache.
*
* @param groupId the group ID
* @param engineKey the engine key
* @param useFinderCache whether to use the finder cache
* @return the matching commerce shipping method, or null if a matching commerce shipping method could not be found
*/
public CommerceShippingMethod fetchByG_E(
long groupId, String engineKey, boolean useFinderCache);
/**
* Removes the commerce shipping method where groupId = ? and engineKey = ? from the database.
*
* @param groupId the group ID
* @param engineKey the engine key
* @return the commerce shipping method that was removed
*/
public CommerceShippingMethod removeByG_E(long groupId, String engineKey)
throws NoSuchShippingMethodException;
/**
* Returns the number of commerce shipping methods where groupId = ? and engineKey = ?.
*
* @param groupId the group ID
* @param engineKey the engine key
* @return the number of matching commerce shipping methods
*/
public int countByG_E(long groupId, String engineKey);
/**
* Caches the commerce shipping method in the entity cache if it is enabled.
*
* @param commerceShippingMethod the commerce shipping method
*/
public void cacheResult(CommerceShippingMethod commerceShippingMethod);
/**
* Caches the commerce shipping methods in the entity cache if it is enabled.
*
* @param commerceShippingMethods the commerce shipping methods
*/
public void cacheResult(
java.util.List commerceShippingMethods);
/**
* Creates a new commerce shipping method with the primary key. Does not add the commerce shipping method to the database.
*
* @param commerceShippingMethodId the primary key for the new commerce shipping method
* @return the new commerce shipping method
*/
public CommerceShippingMethod create(long commerceShippingMethodId);
/**
* Removes the commerce shipping method with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param commerceShippingMethodId the primary key of the commerce shipping method
* @return the commerce shipping method that was removed
* @throws NoSuchShippingMethodException if a commerce shipping method with the primary key could not be found
*/
public CommerceShippingMethod remove(long commerceShippingMethodId)
throws NoSuchShippingMethodException;
public CommerceShippingMethod updateImpl(
CommerceShippingMethod commerceShippingMethod);
/**
* Returns the commerce shipping method with the primary key or throws a NoSuchShippingMethodException if it could not be found.
*
* @param commerceShippingMethodId the primary key of the commerce shipping method
* @return the commerce shipping method
* @throws NoSuchShippingMethodException if a commerce shipping method with the primary key could not be found
*/
public CommerceShippingMethod findByPrimaryKey(
long commerceShippingMethodId)
throws NoSuchShippingMethodException;
/**
* Returns the commerce shipping method with the primary key or returns null if it could not be found.
*
* @param commerceShippingMethodId the primary key of the commerce shipping method
* @return the commerce shipping method, or null if a commerce shipping method with the primary key could not be found
*/
public CommerceShippingMethod fetchByPrimaryKey(
long commerceShippingMethodId);
/**
* Returns all the commerce shipping methods.
*
* @return the commerce shipping methods
*/
public java.util.List findAll();
/**
* Returns a range of all the commerce shipping methods.
*
*
* 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 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 CommerceShippingMethodModelImpl.
*
*
* @param start the lower bound of the range of commerce shipping methods
* @param end the upper bound of the range of commerce shipping methods (not inclusive)
* @return the range of commerce shipping methods
*/
public java.util.List findAll(int start, int end);
/**
* Returns an ordered range of all the commerce shipping methods.
*
*
* 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 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 CommerceShippingMethodModelImpl.
*
*
* @param start the lower bound of the range of commerce shipping methods
* @param end the upper bound of the range of commerce shipping methods (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of commerce shipping methods
*/
public java.util.List findAll(
int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns an ordered range of all the commerce shipping methods.
*
*
* 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 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 CommerceShippingMethodModelImpl.
*
*
* @param start the lower bound of the range of commerce shipping methods
* @param end the upper bound of the range of commerce shipping methods (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @param useFinderCache whether to use the finder cache
* @return the ordered range of commerce shipping methods
*/
public java.util.List findAll(
int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator,
boolean useFinderCache);
/**
* Removes all the commerce shipping methods from the database.
*/
public void removeAll();
/**
* Returns the number of commerce shipping methods.
*
* @return the number of commerce shipping methods
*/
public int countAll();
}