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