001    /**
002     * Copyright (c) 2000-2012 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            public static com.liferay.portal.model.WorkflowInstanceLink fetchWorkflowInstanceLink(
162                    long workflowInstanceLinkId)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().fetchWorkflowInstanceLink(workflowInstanceLinkId);
165            }
166    
167            /**
168            * Returns the workflow instance link with the primary key.
169            *
170            * @param workflowInstanceLinkId the primary key of the workflow instance link
171            * @return the workflow instance link
172            * @throws PortalException if a workflow instance link with the primary key could not be found
173            * @throws SystemException if a system exception occurred
174            */
175            public static com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink(
176                    long workflowInstanceLinkId)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException {
179                    return getService().getWorkflowInstanceLink(workflowInstanceLinkId);
180            }
181    
182            public static com.liferay.portal.model.PersistedModel getPersistedModel(
183                    java.io.Serializable primaryKeyObj)
184                    throws com.liferay.portal.kernel.exception.PortalException,
185                            com.liferay.portal.kernel.exception.SystemException {
186                    return getService().getPersistedModel(primaryKeyObj);
187            }
188    
189            /**
190            * Returns a range of all the workflow instance links.
191            *
192            * <p>
193            * 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.
194            * </p>
195            *
196            * @param start the lower bound of the range of workflow instance links
197            * @param end the upper bound of the range of workflow instance links (not inclusive)
198            * @return the range of workflow instance links
199            * @throws SystemException if a system exception occurred
200            */
201            public static java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks(
202                    int start, int end)
203                    throws com.liferay.portal.kernel.exception.SystemException {
204                    return getService().getWorkflowInstanceLinks(start, end);
205            }
206    
207            /**
208            * Returns the number of workflow instance links.
209            *
210            * @return the number of workflow instance links
211            * @throws SystemException if a system exception occurred
212            */
213            public static int getWorkflowInstanceLinksCount()
214                    throws com.liferay.portal.kernel.exception.SystemException {
215                    return getService().getWorkflowInstanceLinksCount();
216            }
217    
218            /**
219            * Updates the workflow instance link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
220            *
221            * @param workflowInstanceLink the workflow instance link
222            * @return the workflow instance link that was updated
223            * @throws SystemException if a system exception occurred
224            */
225            public static com.liferay.portal.model.WorkflowInstanceLink updateWorkflowInstanceLink(
226                    com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink)
227                    throws com.liferay.portal.kernel.exception.SystemException {
228                    return getService().updateWorkflowInstanceLink(workflowInstanceLink);
229            }
230    
231            /**
232            * Updates the workflow instance link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
233            *
234            * @param workflowInstanceLink the workflow instance link
235            * @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.
236            * @return the workflow instance link that was updated
237            * @throws SystemException if a system exception occurred
238            */
239            public static com.liferay.portal.model.WorkflowInstanceLink updateWorkflowInstanceLink(
240                    com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink,
241                    boolean merge)
242                    throws com.liferay.portal.kernel.exception.SystemException {
243                    return getService()
244                                       .updateWorkflowInstanceLink(workflowInstanceLink, merge);
245            }
246    
247            /**
248            * Returns the Spring bean ID for this bean.
249            *
250            * @return the Spring bean ID for this bean
251            */
252            public static java.lang.String getBeanIdentifier() {
253                    return getService().getBeanIdentifier();
254            }
255    
256            /**
257            * Sets the Spring bean ID for this bean.
258            *
259            * @param beanIdentifier the Spring bean ID for this bean
260            */
261            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
262                    getService().setBeanIdentifier(beanIdentifier);
263            }
264    
265            public static com.liferay.portal.model.WorkflowInstanceLink addWorkflowInstanceLink(
266                    long userId, long companyId, long groupId, java.lang.String className,
267                    long classPK, long workflowInstanceId)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException {
270                    return getService()
271                                       .addWorkflowInstanceLink(userId, companyId, groupId,
272                            className, classPK, workflowInstanceId);
273            }
274    
275            public static void deleteWorkflowInstanceLink(long companyId, long groupId,
276                    java.lang.String className, long classPK)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    getService()
280                            .deleteWorkflowInstanceLink(companyId, groupId, className, classPK);
281            }
282    
283            public static void deleteWorkflowInstanceLinks(long companyId,
284                    long groupId, java.lang.String className, long classPK)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException {
287                    getService()
288                            .deleteWorkflowInstanceLinks(companyId, groupId, className, classPK);
289            }
290    
291            public static com.liferay.portal.model.WorkflowInstanceLink fetchWorkflowInstanceLink(
292                    long companyId, long groupId, java.lang.String className, long classPK)
293                    throws com.liferay.portal.kernel.exception.SystemException {
294                    return getService()
295                                       .fetchWorkflowInstanceLink(companyId, groupId, className,
296                            classPK);
297            }
298    
299            public static java.lang.String getState(long companyId, long groupId,
300                    java.lang.String className, long classPK)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException {
303                    return getService().getState(companyId, groupId, className, classPK);
304            }
305    
306            public static com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink(
307                    long companyId, long groupId, java.lang.String className, long classPK)
308                    throws com.liferay.portal.kernel.exception.PortalException,
309                            com.liferay.portal.kernel.exception.SystemException {
310                    return getService()
311                                       .getWorkflowInstanceLink(companyId, groupId, className,
312                            classPK);
313            }
314    
315            public static java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks(
316                    long companyId, long groupId, java.lang.String className, long classPK)
317                    throws com.liferay.portal.kernel.exception.SystemException {
318                    return getService()
319                                       .getWorkflowInstanceLinks(companyId, groupId, className,
320                            classPK);
321            }
322    
323            public static boolean hasWorkflowInstanceLink(long companyId, long groupId,
324                    java.lang.String className, long classPK)
325                    throws com.liferay.portal.kernel.exception.SystemException {
326                    return getService()
327                                       .hasWorkflowInstanceLink(companyId, groupId, className,
328                            classPK);
329            }
330    
331            public static boolean isEnded(long companyId, long groupId,
332                    java.lang.String className, long classPK)
333                    throws com.liferay.portal.kernel.exception.PortalException,
334                            com.liferay.portal.kernel.exception.SystemException {
335                    return getService().isEnded(companyId, groupId, className, classPK);
336            }
337    
338            public static void startWorkflowInstance(long companyId, long groupId,
339                    long userId, java.lang.String className, long classPK,
340                    java.util.Map<java.lang.String, java.io.Serializable> workflowContext)
341                    throws com.liferay.portal.kernel.exception.PortalException,
342                            com.liferay.portal.kernel.exception.SystemException {
343                    getService()
344                            .startWorkflowInstance(companyId, groupId, userId, className,
345                            classPK, workflowContext);
346            }
347    
348            public static void updateClassPK(long companyId, long groupId,
349                    java.lang.String className, long oldClassPK, long newClassPK)
350                    throws com.liferay.portal.kernel.exception.PortalException,
351                            com.liferay.portal.kernel.exception.SystemException {
352                    getService()
353                            .updateClassPK(companyId, groupId, className, oldClassPK, newClassPK);
354            }
355    
356            public static WorkflowInstanceLinkLocalService getService() {
357                    if (_service == null) {
358                            _service = (WorkflowInstanceLinkLocalService)PortalBeanLocatorUtil.locate(WorkflowInstanceLinkLocalService.class.getName());
359    
360                            ReferenceRegistry.registerReference(WorkflowInstanceLinkLocalServiceUtil.class,
361                                    "_service");
362                            MethodCache.remove(WorkflowInstanceLinkLocalService.class);
363                    }
364    
365                    return _service;
366            }
367    
368            public void setService(WorkflowInstanceLinkLocalService service) {
369                    MethodCache.remove(WorkflowInstanceLinkLocalService.class);
370    
371                    _service = service;
372    
373                    ReferenceRegistry.registerReference(WorkflowInstanceLinkLocalServiceUtil.class,
374                            "_service");
375                    MethodCache.remove(WorkflowInstanceLinkLocalService.class);
376            }
377    
378            private static WorkflowInstanceLinkLocalService _service;
379    }