001 /** 002 * Copyright (c) 2000-2013 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.portal.service.persistence; 016 017 import com.liferay.portal.model.ListType; 018 019 /** 020 * The persistence interface for the list type service. 021 * 022 * <p> 023 * Caching information and settings can be found in <code>portal.properties</code> 024 * </p> 025 * 026 * @author Brian Wing Shun Chan 027 * @see ListTypePersistenceImpl 028 * @see ListTypeUtil 029 * @generated 030 */ 031 public interface ListTypePersistence extends BasePersistence<ListType> { 032 /* 033 * NOTE FOR DEVELOPERS: 034 * 035 * Never modify or reference this interface directly. Always use {@link ListTypeUtil} to access the list type persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface. 036 */ 037 038 /** 039 * Caches the list type in the entity cache if it is enabled. 040 * 041 * @param listType the list type 042 */ 043 public void cacheResult(com.liferay.portal.model.ListType listType); 044 045 /** 046 * Caches the list types in the entity cache if it is enabled. 047 * 048 * @param listTypes the list types 049 */ 050 public void cacheResult( 051 java.util.List<com.liferay.portal.model.ListType> listTypes); 052 053 /** 054 * Creates a new list type with the primary key. Does not add the list type to the database. 055 * 056 * @param listTypeId the primary key for the new list type 057 * @return the new list type 058 */ 059 public com.liferay.portal.model.ListType create(int listTypeId); 060 061 /** 062 * Removes the list type with the primary key from the database. Also notifies the appropriate model listeners. 063 * 064 * @param listTypeId the primary key of the list type 065 * @return the list type that was removed 066 * @throws com.liferay.portal.NoSuchListTypeException if a list type with the primary key could not be found 067 * @throws SystemException if a system exception occurred 068 */ 069 public com.liferay.portal.model.ListType remove(int listTypeId) 070 throws com.liferay.portal.NoSuchListTypeException, 071 com.liferay.portal.kernel.exception.SystemException; 072 073 public com.liferay.portal.model.ListType updateImpl( 074 com.liferay.portal.model.ListType listType, boolean merge) 075 throws com.liferay.portal.kernel.exception.SystemException; 076 077 /** 078 * Returns the list type with the primary key or throws a {@link com.liferay.portal.NoSuchListTypeException} if it could not be found. 079 * 080 * @param listTypeId the primary key of the list type 081 * @return the list type 082 * @throws com.liferay.portal.NoSuchListTypeException if a list type with the primary key could not be found 083 * @throws SystemException if a system exception occurred 084 */ 085 public com.liferay.portal.model.ListType findByPrimaryKey(int listTypeId) 086 throws com.liferay.portal.NoSuchListTypeException, 087 com.liferay.portal.kernel.exception.SystemException; 088 089 /** 090 * Returns the list type with the primary key or returns <code>null</code> if it could not be found. 091 * 092 * @param listTypeId the primary key of the list type 093 * @return the list type, or <code>null</code> if a list type with the primary key could not be found 094 * @throws SystemException if a system exception occurred 095 */ 096 public com.liferay.portal.model.ListType fetchByPrimaryKey(int listTypeId) 097 throws com.liferay.portal.kernel.exception.SystemException; 098 099 /** 100 * Returns all the list types where type = ?. 101 * 102 * @param type the type 103 * @return the matching list types 104 * @throws SystemException if a system exception occurred 105 */ 106 public java.util.List<com.liferay.portal.model.ListType> findByType( 107 java.lang.String type) 108 throws com.liferay.portal.kernel.exception.SystemException; 109 110 /** 111 * Returns a range of all the list types where type = ?. 112 * 113 * <p> 114 * 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. 115 * </p> 116 * 117 * @param type the type 118 * @param start the lower bound of the range of list types 119 * @param end the upper bound of the range of list types (not inclusive) 120 * @return the range of matching list types 121 * @throws SystemException if a system exception occurred 122 */ 123 public java.util.List<com.liferay.portal.model.ListType> findByType( 124 java.lang.String type, int start, int end) 125 throws com.liferay.portal.kernel.exception.SystemException; 126 127 /** 128 * Returns an ordered range of all the list types where type = ?. 129 * 130 * <p> 131 * 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. 132 * </p> 133 * 134 * @param type the type 135 * @param start the lower bound of the range of list types 136 * @param end the upper bound of the range of list types (not inclusive) 137 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 138 * @return the ordered range of matching list types 139 * @throws SystemException if a system exception occurred 140 */ 141 public java.util.List<com.liferay.portal.model.ListType> findByType( 142 java.lang.String type, int start, int end, 143 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 144 throws com.liferay.portal.kernel.exception.SystemException; 145 146 /** 147 * Returns the first list type in the ordered set where type = ?. 148 * 149 * @param type the type 150 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 151 * @return the first matching list type 152 * @throws com.liferay.portal.NoSuchListTypeException if a matching list type could not be found 153 * @throws SystemException if a system exception occurred 154 */ 155 public com.liferay.portal.model.ListType findByType_First( 156 java.lang.String type, 157 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 158 throws com.liferay.portal.NoSuchListTypeException, 159 com.liferay.portal.kernel.exception.SystemException; 160 161 /** 162 * Returns the first list type in the ordered set where type = ?. 163 * 164 * @param type the type 165 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 166 * @return the first matching list type, or <code>null</code> if a matching list type could not be found 167 * @throws SystemException if a system exception occurred 168 */ 169 public com.liferay.portal.model.ListType fetchByType_First( 170 java.lang.String type, 171 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 172 throws com.liferay.portal.kernel.exception.SystemException; 173 174 /** 175 * Returns the last list type in the ordered set where type = ?. 176 * 177 * @param type the type 178 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 179 * @return the last matching list type 180 * @throws com.liferay.portal.NoSuchListTypeException if a matching list type could not be found 181 * @throws SystemException if a system exception occurred 182 */ 183 public com.liferay.portal.model.ListType findByType_Last( 184 java.lang.String type, 185 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 186 throws com.liferay.portal.NoSuchListTypeException, 187 com.liferay.portal.kernel.exception.SystemException; 188 189 /** 190 * Returns the last list type in the ordered set where type = ?. 191 * 192 * @param type the type 193 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 194 * @return the last matching list type, or <code>null</code> if a matching list type could not be found 195 * @throws SystemException if a system exception occurred 196 */ 197 public com.liferay.portal.model.ListType fetchByType_Last( 198 java.lang.String type, 199 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 200 throws com.liferay.portal.kernel.exception.SystemException; 201 202 /** 203 * Returns the list types before and after the current list type in the ordered set where type = ?. 204 * 205 * @param listTypeId the primary key of the current list type 206 * @param type the type 207 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 208 * @return the previous, current, and next list type 209 * @throws com.liferay.portal.NoSuchListTypeException if a list type with the primary key could not be found 210 * @throws SystemException if a system exception occurred 211 */ 212 public com.liferay.portal.model.ListType[] findByType_PrevAndNext( 213 int listTypeId, java.lang.String type, 214 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 215 throws com.liferay.portal.NoSuchListTypeException, 216 com.liferay.portal.kernel.exception.SystemException; 217 218 /** 219 * Returns all the list types. 220 * 221 * @return the list types 222 * @throws SystemException if a system exception occurred 223 */ 224 public java.util.List<com.liferay.portal.model.ListType> findAll() 225 throws com.liferay.portal.kernel.exception.SystemException; 226 227 /** 228 * Returns a range of all the list types. 229 * 230 * <p> 231 * 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. 232 * </p> 233 * 234 * @param start the lower bound of the range of list types 235 * @param end the upper bound of the range of list types (not inclusive) 236 * @return the range of list types 237 * @throws SystemException if a system exception occurred 238 */ 239 public java.util.List<com.liferay.portal.model.ListType> findAll( 240 int start, int end) 241 throws com.liferay.portal.kernel.exception.SystemException; 242 243 /** 244 * Returns an ordered range of all the list types. 245 * 246 * <p> 247 * 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. 248 * </p> 249 * 250 * @param start the lower bound of the range of list types 251 * @param end the upper bound of the range of list types (not inclusive) 252 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 253 * @return the ordered range of list types 254 * @throws SystemException if a system exception occurred 255 */ 256 public java.util.List<com.liferay.portal.model.ListType> findAll( 257 int start, int end, 258 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 259 throws com.liferay.portal.kernel.exception.SystemException; 260 261 /** 262 * Removes all the list types where type = ? from the database. 263 * 264 * @param type the type 265 * @throws SystemException if a system exception occurred 266 */ 267 public void removeByType(java.lang.String type) 268 throws com.liferay.portal.kernel.exception.SystemException; 269 270 /** 271 * Removes all the list types from the database. 272 * 273 * @throws SystemException if a system exception occurred 274 */ 275 public void removeAll() 276 throws com.liferay.portal.kernel.exception.SystemException; 277 278 /** 279 * Returns the number of list types where type = ?. 280 * 281 * @param type the type 282 * @return the number of matching list types 283 * @throws SystemException if a system exception occurred 284 */ 285 public int countByType(java.lang.String type) 286 throws com.liferay.portal.kernel.exception.SystemException; 287 288 /** 289 * Returns the number of list types. 290 * 291 * @return the number of list types 292 * @throws SystemException if a system exception occurred 293 */ 294 public int countAll() 295 throws com.liferay.portal.kernel.exception.SystemException; 296 }