ShoppingOrderItemPersistence.java

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.shopping.service.persistence;

import aQute.bnd.annotation.ProviderType;

import com.liferay.portal.kernel.service.persistence.BasePersistence;

import com.liferay.shopping.exception.NoSuchOrderItemException;
import com.liferay.shopping.model.ShoppingOrderItem;

/**
 * The persistence interface for the shopping order item service.
 *
 * <p>
 * Caching information and settings can be found in <code>portal.properties</code>
 * </p>
 *
 * @author Brian Wing Shun Chan
 * @see com.liferay.shopping.service.persistence.impl.ShoppingOrderItemPersistenceImpl
 * @see ShoppingOrderItemUtil
 * @generated
 */
@ProviderType
public interface ShoppingOrderItemPersistence extends BasePersistence<ShoppingOrderItem> {
	/*
	 * NOTE FOR DEVELOPERS:
	 *
	 * Never modify or reference this interface directly. Always use {@link ShoppingOrderItemUtil} to access the shopping order item persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface.
	 */

	/**
	* Returns all the shopping order items where orderId = ?.
	*
	* @param orderId the order ID
	* @return the matching shopping order items
	*/
	public java.util.List<ShoppingOrderItem> findByOrderId(long orderId);

	/**
	* Returns a range of all the shopping order items where orderId = ?.
	*
	* <p>
	* Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link ShoppingOrderItemModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
	* </p>
	*
	* @param orderId the order ID
	* @param start the lower bound of the range of shopping order items
	* @param end the upper bound of the range of shopping order items (not inclusive)
	* @return the range of matching shopping order items
	*/
	public java.util.List<ShoppingOrderItem> findByOrderId(long orderId,
		int start, int end);

	/**
	* Returns an ordered range of all the shopping order items where orderId = ?.
	*
	* <p>
	* Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link ShoppingOrderItemModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
	* </p>
	*
	* @param orderId the order ID
	* @param start the lower bound of the range of shopping order items
	* @param end the upper bound of the range of shopping order items (not inclusive)
	* @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
	* @return the ordered range of matching shopping order items
	*/
	public java.util.List<ShoppingOrderItem> findByOrderId(long orderId,
		int start, int end,
		com.liferay.portal.kernel.util.OrderByComparator<ShoppingOrderItem> orderByComparator);

	/**
	* Returns an ordered range of all the shopping order items where orderId = ?.
	*
	* <p>
	* Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link ShoppingOrderItemModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
	* </p>
	*
	* @param orderId the order ID
	* @param start the lower bound of the range of shopping order items
	* @param end the upper bound of the range of shopping order items (not inclusive)
	* @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
	* @param retrieveFromCache whether to retrieve from the finder cache
	* @return the ordered range of matching shopping order items
	*/
	public java.util.List<ShoppingOrderItem> findByOrderId(long orderId,
		int start, int end,
		com.liferay.portal.kernel.util.OrderByComparator<ShoppingOrderItem> orderByComparator,
		boolean retrieveFromCache);

	/**
	* Returns the first shopping order item in the ordered set where orderId = ?.
	*
	* @param orderId the order ID
	* @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
	* @return the first matching shopping order item
	* @throws NoSuchOrderItemException if a matching shopping order item could not be found
	*/
	public ShoppingOrderItem findByOrderId_First(long orderId,
		com.liferay.portal.kernel.util.OrderByComparator<ShoppingOrderItem> orderByComparator)
		throws NoSuchOrderItemException;

	/**
	* Returns the first shopping order item in the ordered set where orderId = ?.
	*
	* @param orderId the order ID
	* @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
	* @return the first matching shopping order item, or <code>null</code> if a matching shopping order item could not be found
	*/
	public ShoppingOrderItem fetchByOrderId_First(long orderId,
		com.liferay.portal.kernel.util.OrderByComparator<ShoppingOrderItem> orderByComparator);

	/**
	* Returns the last shopping order item in the ordered set where orderId = ?.
	*
	* @param orderId the order ID
	* @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
	* @return the last matching shopping order item
	* @throws NoSuchOrderItemException if a matching shopping order item could not be found
	*/
	public ShoppingOrderItem findByOrderId_Last(long orderId,
		com.liferay.portal.kernel.util.OrderByComparator<ShoppingOrderItem> orderByComparator)
		throws NoSuchOrderItemException;

	/**
	* Returns the last shopping order item in the ordered set where orderId = ?.
	*
	* @param orderId the order ID
	* @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
	* @return the last matching shopping order item, or <code>null</code> if a matching shopping order item could not be found
	*/
	public ShoppingOrderItem fetchByOrderId_Last(long orderId,
		com.liferay.portal.kernel.util.OrderByComparator<ShoppingOrderItem> orderByComparator);

	/**
	* Returns the shopping order items before and after the current shopping order item in the ordered set where orderId = ?.
	*
	* @param orderItemId the primary key of the current shopping order item
	* @param orderId the order ID
	* @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
	* @return the previous, current, and next shopping order item
	* @throws NoSuchOrderItemException if a shopping order item with the primary key could not be found
	*/
	public ShoppingOrderItem[] findByOrderId_PrevAndNext(long orderItemId,
		long orderId,
		com.liferay.portal.kernel.util.OrderByComparator<ShoppingOrderItem> orderByComparator)
		throws NoSuchOrderItemException;

	/**
	* Removes all the shopping order items where orderId = ? from the database.
	*
	* @param orderId the order ID
	*/
	public void removeByOrderId(long orderId);

	/**
	* Returns the number of shopping order items where orderId = ?.
	*
	* @param orderId the order ID
	* @return the number of matching shopping order items
	*/
	public int countByOrderId(long orderId);

	/**
	* Caches the shopping order item in the entity cache if it is enabled.
	*
	* @param shoppingOrderItem the shopping order item
	*/
	public void cacheResult(ShoppingOrderItem shoppingOrderItem);

	/**
	* Caches the shopping order items in the entity cache if it is enabled.
	*
	* @param shoppingOrderItems the shopping order items
	*/
	public void cacheResult(
		java.util.List<ShoppingOrderItem> shoppingOrderItems);

	/**
	* Creates a new shopping order item with the primary key. Does not add the shopping order item to the database.
	*
	* @param orderItemId the primary key for the new shopping order item
	* @return the new shopping order item
	*/
	public ShoppingOrderItem create(long orderItemId);

	/**
	* Removes the shopping order item with the primary key from the database. Also notifies the appropriate model listeners.
	*
	* @param orderItemId the primary key of the shopping order item
	* @return the shopping order item that was removed
	* @throws NoSuchOrderItemException if a shopping order item with the primary key could not be found
	*/
	public ShoppingOrderItem remove(long orderItemId)
		throws NoSuchOrderItemException;

	public ShoppingOrderItem updateImpl(ShoppingOrderItem shoppingOrderItem);

	/**
	* Returns the shopping order item with the primary key or throws a {@link NoSuchOrderItemException} if it could not be found.
	*
	* @param orderItemId the primary key of the shopping order item
	* @return the shopping order item
	* @throws NoSuchOrderItemException if a shopping order item with the primary key could not be found
	*/
	public ShoppingOrderItem findByPrimaryKey(long orderItemId)
		throws NoSuchOrderItemException;

	/**
	* Returns the shopping order item with the primary key or returns <code>null</code> if it could not be found.
	*
	* @param orderItemId the primary key of the shopping order item
	* @return the shopping order item, or <code>null</code> if a shopping order item with the primary key could not be found
	*/
	public ShoppingOrderItem fetchByPrimaryKey(long orderItemId);

	@Override
	public java.util.Map<java.io.Serializable, ShoppingOrderItem> fetchByPrimaryKeys(
		java.util.Set<java.io.Serializable> primaryKeys);

	/**
	* Returns all the shopping order items.
	*
	* @return the shopping order items
	*/
	public java.util.List<ShoppingOrderItem> findAll();

	/**
	* Returns a range of all the shopping order items.
	*
	* <p>
	* Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link ShoppingOrderItemModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
	* </p>
	*
	* @param start the lower bound of the range of shopping order items
	* @param end the upper bound of the range of shopping order items (not inclusive)
	* @return the range of shopping order items
	*/
	public java.util.List<ShoppingOrderItem> findAll(int start, int end);

	/**
	* Returns an ordered range of all the shopping order items.
	*
	* <p>
	* Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link ShoppingOrderItemModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
	* </p>
	*
	* @param start the lower bound of the range of shopping order items
	* @param end the upper bound of the range of shopping order items (not inclusive)
	* @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
	* @return the ordered range of shopping order items
	*/
	public java.util.List<ShoppingOrderItem> findAll(int start, int end,
		com.liferay.portal.kernel.util.OrderByComparator<ShoppingOrderItem> orderByComparator);

	/**
	* Returns an ordered range of all the shopping order items.
	*
	* <p>
	* Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link ShoppingOrderItemModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
	* </p>
	*
	* @param start the lower bound of the range of shopping order items
	* @param end the upper bound of the range of shopping order items (not inclusive)
	* @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
	* @param retrieveFromCache whether to retrieve from the finder cache
	* @return the ordered range of shopping order items
	*/
	public java.util.List<ShoppingOrderItem> findAll(int start, int end,
		com.liferay.portal.kernel.util.OrderByComparator<ShoppingOrderItem> orderByComparator,
		boolean retrieveFromCache);

	/**
	* Removes all the shopping order items from the database.
	*/
	public void removeAll();

	/**
	* Returns the number of shopping order items.
	*
	* @return the number of shopping order items
	*/
	public int countAll();
}