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