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