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