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