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