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