001    /**
002     * Copyright (c) 2000-2011 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;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * The utility for the workflow instance link local service. This utility wraps {@link com.liferay.portal.service.impl.WorkflowInstanceLinkLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
023     *
024     * <p>
025     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see WorkflowInstanceLinkLocalService
030     * @see com.liferay.portal.service.base.WorkflowInstanceLinkLocalServiceBaseImpl
031     * @see com.liferay.portal.service.impl.WorkflowInstanceLinkLocalServiceImpl
032     * @generated
033     */
034    public class WorkflowInstanceLinkLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.WorkflowInstanceLinkLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the workflow instance link to the database. Also notifies the appropriate model listeners.
043            *
044            * @param workflowInstanceLink the workflow instance link
045            * @return the workflow instance link that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portal.model.WorkflowInstanceLink addWorkflowInstanceLink(
049                    com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addWorkflowInstanceLink(workflowInstanceLink);
052            }
053    
054            /**
055            * Creates a new workflow instance link with the primary key. Does not add the workflow instance link to the database.
056            *
057            * @param workflowInstanceLinkId the primary key for the new workflow instance link
058            * @return the new workflow instance link
059            */
060            public static com.liferay.portal.model.WorkflowInstanceLink createWorkflowInstanceLink(
061                    long workflowInstanceLinkId) {
062                    return getService().createWorkflowInstanceLink(workflowInstanceLinkId);
063            }
064    
065            /**
066            * Deletes the workflow instance link with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param workflowInstanceLinkId the primary key of the workflow instance link
069            * @throws PortalException if a workflow instance link with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteWorkflowInstanceLink(long workflowInstanceLinkId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteWorkflowInstanceLink(workflowInstanceLinkId);
076            }
077    
078            /**
079            * Deletes the workflow instance link from the database. Also notifies the appropriate model listeners.
080            *
081            * @param workflowInstanceLink the workflow instance link
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteWorkflowInstanceLink(
085                    com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteWorkflowInstanceLink(workflowInstanceLink);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * 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.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * 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.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            /**
162            * Returns the workflow instance link with the primary key.
163            *
164            * @param workflowInstanceLinkId the primary key of the workflow instance link
165            * @return the workflow instance link
166            * @throws PortalException if a workflow instance link with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink(
170                    long workflowInstanceLinkId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getWorkflowInstanceLink(workflowInstanceLinkId);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns a range of all the workflow instance links.
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 start the lower bound of the range of workflow instance links
191            * @param end the upper bound of the range of workflow instance links (not inclusive)
192            * @return the range of workflow instance links
193            * @throws SystemException if a system exception occurred
194            */
195            public static java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks(
196                    int start, int end)
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getWorkflowInstanceLinks(start, end);
199            }
200    
201            /**
202            * Returns the number of workflow instance links.
203            *
204            * @return the number of workflow instance links
205            * @throws SystemException if a system exception occurred
206            */
207            public static int getWorkflowInstanceLinksCount()
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return getService().getWorkflowInstanceLinksCount();
210            }
211    
212            /**
213            * Updates the workflow instance link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param workflowInstanceLink the workflow instance link
216            * @return the workflow instance link that was updated
217            * @throws SystemException if a system exception occurred
218            */
219            public static com.liferay.portal.model.WorkflowInstanceLink updateWorkflowInstanceLink(
220                    com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink)
221                    throws com.liferay.portal.kernel.exception.SystemException {
222                    return getService().updateWorkflowInstanceLink(workflowInstanceLink);
223            }
224    
225            /**
226            * Updates the workflow instance link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
227            *
228            * @param workflowInstanceLink the workflow instance link
229            * @param merge whether to merge the workflow instance link with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
230            * @return the workflow instance link that was updated
231            * @throws SystemException if a system exception occurred
232            */
233            public static com.liferay.portal.model.WorkflowInstanceLink updateWorkflowInstanceLink(
234                    com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink,
235                    boolean merge)
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService()
238                                       .updateWorkflowInstanceLink(workflowInstanceLink, merge);
239            }
240    
241            /**
242            * Returns the Spring bean ID for this bean.
243            *
244            * @return the Spring bean ID for this bean
245            */
246            public static java.lang.String getBeanIdentifier() {
247                    return getService().getBeanIdentifier();
248            }
249    
250            /**
251            * Sets the Spring bean ID for this bean.
252            *
253            * @param beanIdentifier the Spring bean ID for this bean
254            */
255            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
256                    getService().setBeanIdentifier(beanIdentifier);
257            }
258    
259            public static com.liferay.portal.model.WorkflowInstanceLink addWorkflowInstanceLink(
260                    long userId, long companyId, long groupId, java.lang.String className,
261                    long classPK, long workflowInstanceId)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException {
264                    return getService()
265                                       .addWorkflowInstanceLink(userId, companyId, groupId,
266                            className, classPK, workflowInstanceId);
267            }
268    
269            public static void deleteWorkflowInstanceLink(long companyId, long groupId,
270                    java.lang.String className, long classPK)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException {
273                    getService()
274                            .deleteWorkflowInstanceLink(companyId, groupId, className, classPK);
275            }
276    
277            public static void deleteWorkflowInstanceLinks(long companyId,
278                    long groupId, java.lang.String className, long classPK)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException {
281                    getService()
282                            .deleteWorkflowInstanceLinks(companyId, groupId, className, classPK);
283            }
284    
285            public static com.liferay.portal.model.WorkflowInstanceLink fetchWorkflowInstanceLink(
286                    long companyId, long groupId, java.lang.String className, long classPK)
287                    throws com.liferay.portal.kernel.exception.SystemException {
288                    return getService()
289                                       .fetchWorkflowInstanceLink(companyId, groupId, className,
290                            classPK);
291            }
292    
293            public static java.lang.String getState(long companyId, long groupId,
294                    java.lang.String className, long classPK)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException {
297                    return getService().getState(companyId, groupId, className, classPK);
298            }
299    
300            public static com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink(
301                    long companyId, long groupId, java.lang.String className, long classPK)
302                    throws com.liferay.portal.kernel.exception.PortalException,
303                            com.liferay.portal.kernel.exception.SystemException {
304                    return getService()
305                                       .getWorkflowInstanceLink(companyId, groupId, className,
306                            classPK);
307            }
308    
309            public static java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks(
310                    long companyId, long groupId, java.lang.String className, long classPK)
311                    throws com.liferay.portal.kernel.exception.SystemException {
312                    return getService()
313                                       .getWorkflowInstanceLinks(companyId, groupId, className,
314                            classPK);
315            }
316    
317            public static boolean hasWorkflowInstanceLink(long companyId, long groupId,
318                    java.lang.String className, long classPK)
319                    throws com.liferay.portal.kernel.exception.SystemException {
320                    return getService()
321                                       .hasWorkflowInstanceLink(companyId, groupId, className,
322                            classPK);
323            }
324    
325            public static boolean isEnded(long companyId, long groupId,
326                    java.lang.String className, long classPK)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException {
329                    return getService().isEnded(companyId, groupId, className, classPK);
330            }
331    
332            public static void startWorkflowInstance(long companyId, long groupId,
333                    long userId, java.lang.String className, long classPK,
334                    java.util.Map<java.lang.String, java.io.Serializable> workflowContext)
335                    throws com.liferay.portal.kernel.exception.PortalException,
336                            com.liferay.portal.kernel.exception.SystemException {
337                    getService()
338                            .startWorkflowInstance(companyId, groupId, userId, className,
339                            classPK, workflowContext);
340            }
341    
342            public static void updateClassPK(long companyId, long groupId,
343                    java.lang.String className, long oldClassPK, long newClassPK)
344                    throws com.liferay.portal.kernel.exception.PortalException,
345                            com.liferay.portal.kernel.exception.SystemException {
346                    getService()
347                            .updateClassPK(companyId, groupId, className, oldClassPK, newClassPK);
348            }
349    
350            public static WorkflowInstanceLinkLocalService getService() {
351                    if (_service == null) {
352                            _service = (WorkflowInstanceLinkLocalService)PortalBeanLocatorUtil.locate(WorkflowInstanceLinkLocalService.class.getName());
353    
354                            ReferenceRegistry.registerReference(WorkflowInstanceLinkLocalServiceUtil.class,
355                                    "_service");
356                            MethodCache.remove(WorkflowInstanceLinkLocalService.class);
357                    }
358    
359                    return _service;
360            }
361    
362            public void setService(WorkflowInstanceLinkLocalService service) {
363                    MethodCache.remove(WorkflowInstanceLinkLocalService.class);
364    
365                    _service = service;
366    
367                    ReferenceRegistry.registerReference(WorkflowInstanceLinkLocalServiceUtil.class,
368                            "_service");
369                    MethodCache.remove(WorkflowInstanceLinkLocalService.class);
370            }
371    
372            private static WorkflowInstanceLinkLocalService _service;
373    }