001 /** 002 * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portlet.shopping.service.persistence; 016 017 import com.liferay.portal.service.persistence.BasePersistence; 018 019 import com.liferay.portlet.shopping.model.ShoppingOrderItem; 020 021 /** 022 * The persistence interface for the shopping order item service. 023 * 024 * <p> 025 * Caching information and settings can be found in <code>portal.properties</code> 026 * </p> 027 * 028 * @author Brian Wing Shun Chan 029 * @see ShoppingOrderItemPersistenceImpl 030 * @see ShoppingOrderItemUtil 031 * @generated 032 */ 033 public interface ShoppingOrderItemPersistence extends BasePersistence<ShoppingOrderItem> { 034 /* 035 * NOTE FOR DEVELOPERS: 036 * 037 * 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. 038 */ 039 040 /** 041 * Caches the shopping order item in the entity cache if it is enabled. 042 * 043 * @param shoppingOrderItem the shopping order item 044 */ 045 public void cacheResult( 046 com.liferay.portlet.shopping.model.ShoppingOrderItem shoppingOrderItem); 047 048 /** 049 * Caches the shopping order items in the entity cache if it is enabled. 050 * 051 * @param shoppingOrderItems the shopping order items 052 */ 053 public void cacheResult( 054 java.util.List<com.liferay.portlet.shopping.model.ShoppingOrderItem> shoppingOrderItems); 055 056 /** 057 * Creates a new shopping order item with the primary key. Does not add the shopping order item to the database. 058 * 059 * @param orderItemId the primary key for the new shopping order item 060 * @return the new shopping order item 061 */ 062 public com.liferay.portlet.shopping.model.ShoppingOrderItem create( 063 long orderItemId); 064 065 /** 066 * Removes the shopping order item with the primary key from the database. Also notifies the appropriate model listeners. 067 * 068 * @param orderItemId the primary key of the shopping order item 069 * @return the shopping order item that was removed 070 * @throws com.liferay.portlet.shopping.NoSuchOrderItemException if a shopping order item with the primary key could not be found 071 * @throws SystemException if a system exception occurred 072 */ 073 public com.liferay.portlet.shopping.model.ShoppingOrderItem remove( 074 long orderItemId) 075 throws com.liferay.portal.kernel.exception.SystemException, 076 com.liferay.portlet.shopping.NoSuchOrderItemException; 077 078 public com.liferay.portlet.shopping.model.ShoppingOrderItem updateImpl( 079 com.liferay.portlet.shopping.model.ShoppingOrderItem shoppingOrderItem, 080 boolean merge) 081 throws com.liferay.portal.kernel.exception.SystemException; 082 083 /** 084 * Returns the shopping order item with the primary key or throws a {@link com.liferay.portlet.shopping.NoSuchOrderItemException} if it could not be found. 085 * 086 * @param orderItemId the primary key of the shopping order item 087 * @return the shopping order item 088 * @throws com.liferay.portlet.shopping.NoSuchOrderItemException if a shopping order item with the primary key could not be found 089 * @throws SystemException if a system exception occurred 090 */ 091 public com.liferay.portlet.shopping.model.ShoppingOrderItem findByPrimaryKey( 092 long orderItemId) 093 throws com.liferay.portal.kernel.exception.SystemException, 094 com.liferay.portlet.shopping.NoSuchOrderItemException; 095 096 /** 097 * Returns the shopping order item with the primary key or returns <code>null</code> if it could not be found. 098 * 099 * @param orderItemId the primary key of the shopping order item 100 * @return the shopping order item, or <code>null</code> if a shopping order item with the primary key could not be found 101 * @throws SystemException if a system exception occurred 102 */ 103 public com.liferay.portlet.shopping.model.ShoppingOrderItem fetchByPrimaryKey( 104 long orderItemId) 105 throws com.liferay.portal.kernel.exception.SystemException; 106 107 /** 108 * Returns all the shopping order items where orderId = ?. 109 * 110 * @param orderId the order ID 111 * @return the matching shopping order items 112 * @throws SystemException if a system exception occurred 113 */ 114 public java.util.List<com.liferay.portlet.shopping.model.ShoppingOrderItem> findByOrderId( 115 long orderId) 116 throws com.liferay.portal.kernel.exception.SystemException; 117 118 /** 119 * Returns a range of all the shopping order items where orderId = ?. 120 * 121 * <p> 122 * 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. 123 * </p> 124 * 125 * @param orderId the order ID 126 * @param start the lower bound of the range of shopping order items 127 * @param end the upper bound of the range of shopping order items (not inclusive) 128 * @return the range of matching shopping order items 129 * @throws SystemException if a system exception occurred 130 */ 131 public java.util.List<com.liferay.portlet.shopping.model.ShoppingOrderItem> findByOrderId( 132 long orderId, int start, int end) 133 throws com.liferay.portal.kernel.exception.SystemException; 134 135 /** 136 * Returns an ordered range of all the shopping order items where orderId = ?. 137 * 138 * <p> 139 * 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. 140 * </p> 141 * 142 * @param orderId the order ID 143 * @param start the lower bound of the range of shopping order items 144 * @param end the upper bound of the range of shopping order items (not inclusive) 145 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 146 * @return the ordered range of matching shopping order items 147 * @throws SystemException if a system exception occurred 148 */ 149 public java.util.List<com.liferay.portlet.shopping.model.ShoppingOrderItem> findByOrderId( 150 long orderId, int start, int end, 151 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 152 throws com.liferay.portal.kernel.exception.SystemException; 153 154 /** 155 * Returns the first shopping order item in the ordered set where orderId = ?. 156 * 157 * <p> 158 * 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. 159 * </p> 160 * 161 * @param orderId the order ID 162 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 163 * @return the first matching shopping order item 164 * @throws com.liferay.portlet.shopping.NoSuchOrderItemException if a matching shopping order item could not be found 165 * @throws SystemException if a system exception occurred 166 */ 167 public com.liferay.portlet.shopping.model.ShoppingOrderItem findByOrderId_First( 168 long orderId, 169 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 170 throws com.liferay.portal.kernel.exception.SystemException, 171 com.liferay.portlet.shopping.NoSuchOrderItemException; 172 173 /** 174 * Returns the last shopping order item in the ordered set where orderId = ?. 175 * 176 * <p> 177 * 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. 178 * </p> 179 * 180 * @param orderId the order ID 181 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 182 * @return the last matching shopping order item 183 * @throws com.liferay.portlet.shopping.NoSuchOrderItemException if a matching shopping order item could not be found 184 * @throws SystemException if a system exception occurred 185 */ 186 public com.liferay.portlet.shopping.model.ShoppingOrderItem findByOrderId_Last( 187 long orderId, 188 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 189 throws com.liferay.portal.kernel.exception.SystemException, 190 com.liferay.portlet.shopping.NoSuchOrderItemException; 191 192 /** 193 * Returns the shopping order items before and after the current shopping order item in the ordered set where orderId = ?. 194 * 195 * <p> 196 * 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. 197 * </p> 198 * 199 * @param orderItemId the primary key of the current shopping order item 200 * @param orderId the order ID 201 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 202 * @return the previous, current, and next shopping order item 203 * @throws com.liferay.portlet.shopping.NoSuchOrderItemException if a shopping order item with the primary key could not be found 204 * @throws SystemException if a system exception occurred 205 */ 206 public com.liferay.portlet.shopping.model.ShoppingOrderItem[] findByOrderId_PrevAndNext( 207 long orderItemId, long orderId, 208 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 209 throws com.liferay.portal.kernel.exception.SystemException, 210 com.liferay.portlet.shopping.NoSuchOrderItemException; 211 212 /** 213 * Returns all the shopping order items. 214 * 215 * @return the shopping order items 216 * @throws SystemException if a system exception occurred 217 */ 218 public java.util.List<com.liferay.portlet.shopping.model.ShoppingOrderItem> findAll() 219 throws com.liferay.portal.kernel.exception.SystemException; 220 221 /** 222 * Returns a range of all the shopping order items. 223 * 224 * <p> 225 * 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. 226 * </p> 227 * 228 * @param start the lower bound of the range of shopping order items 229 * @param end the upper bound of the range of shopping order items (not inclusive) 230 * @return the range of shopping order items 231 * @throws SystemException if a system exception occurred 232 */ 233 public java.util.List<com.liferay.portlet.shopping.model.ShoppingOrderItem> findAll( 234 int start, int end) 235 throws com.liferay.portal.kernel.exception.SystemException; 236 237 /** 238 * Returns an ordered range of all the shopping order items. 239 * 240 * <p> 241 * 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. 242 * </p> 243 * 244 * @param start the lower bound of the range of shopping order items 245 * @param end the upper bound of the range of shopping order items (not inclusive) 246 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 247 * @return the ordered range of shopping order items 248 * @throws SystemException if a system exception occurred 249 */ 250 public java.util.List<com.liferay.portlet.shopping.model.ShoppingOrderItem> findAll( 251 int start, int end, 252 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 253 throws com.liferay.portal.kernel.exception.SystemException; 254 255 /** 256 * Removes all the shopping order items where orderId = ? from the database. 257 * 258 * @param orderId the order ID 259 * @throws SystemException if a system exception occurred 260 */ 261 public void removeByOrderId(long orderId) 262 throws com.liferay.portal.kernel.exception.SystemException; 263 264 /** 265 * Removes all the shopping order items from the database. 266 * 267 * @throws SystemException if a system exception occurred 268 */ 269 public void removeAll() 270 throws com.liferay.portal.kernel.exception.SystemException; 271 272 /** 273 * Returns the number of shopping order items where orderId = ?. 274 * 275 * @param orderId the order ID 276 * @return the number of matching shopping order items 277 * @throws SystemException if a system exception occurred 278 */ 279 public int countByOrderId(long orderId) 280 throws com.liferay.portal.kernel.exception.SystemException; 281 282 /** 283 * Returns the number of shopping order items. 284 * 285 * @return the number of shopping order items 286 * @throws SystemException if a system exception occurred 287 */ 288 public int countAll() 289 throws com.liferay.portal.kernel.exception.SystemException; 290 }