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