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     * Provides the local service utility for WorkflowInstanceLink. This utility wraps
022     * {@link com.liferay.portal.service.impl.WorkflowInstanceLinkLocalServiceImpl} and is the
023     * primary access point for service operations in application layer code running
024     * on the local server. Methods of this service will not have security checks
025     * based on the propagated JAAS credentials because this service can only be
026     * accessed from within the same VM.
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            * @return the workflow instance link that was removed
070            * @throws PortalException if a workflow instance link with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public static com.liferay.portal.model.WorkflowInstanceLink deleteWorkflowInstanceLink(
074                    long workflowInstanceLinkId)
075                    throws com.liferay.portal.kernel.exception.PortalException,
076                            com.liferay.portal.kernel.exception.SystemException {
077                    return getService().deleteWorkflowInstanceLink(workflowInstanceLinkId);
078            }
079    
080            /**
081            * Deletes the workflow instance link from the database. Also notifies the appropriate model listeners.
082            *
083            * @param workflowInstanceLink the workflow instance link
084            * @return the workflow instance link that was removed
085            * @throws PortalException
086            * @throws SystemException if a system exception occurred
087            */
088            public static com.liferay.portal.model.WorkflowInstanceLink deleteWorkflowInstanceLink(
089                    com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink)
090                    throws com.liferay.portal.kernel.exception.PortalException,
091                            com.liferay.portal.kernel.exception.SystemException {
092                    return getService().deleteWorkflowInstanceLink(workflowInstanceLink);
093            }
094    
095            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
096                    return getService().dynamicQuery();
097            }
098    
099            /**
100            * Performs a dynamic query on the database and returns the matching rows.
101            *
102            * @param dynamicQuery the dynamic query
103            * @return the matching rows
104            * @throws SystemException if a system exception occurred
105            */
106            @SuppressWarnings("rawtypes")
107            public static java.util.List dynamicQuery(
108                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
109                    throws com.liferay.portal.kernel.exception.SystemException {
110                    return getService().dynamicQuery(dynamicQuery);
111            }
112    
113            /**
114            * Performs a dynamic query on the database and returns a range of the matching rows.
115            *
116            * <p>
117            * 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.
118            * </p>
119            *
120            * @param dynamicQuery the dynamic query
121            * @param start the lower bound of the range of model instances
122            * @param end the upper bound of the range of model instances (not inclusive)
123            * @return the range of matching rows
124            * @throws SystemException if a system exception occurred
125            */
126            @SuppressWarnings("rawtypes")
127            public static java.util.List dynamicQuery(
128                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
129                    int end) throws com.liferay.portal.kernel.exception.SystemException {
130                    return getService().dynamicQuery(dynamicQuery, start, end);
131            }
132    
133            /**
134            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
135            *
136            * <p>
137            * 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.
138            * </p>
139            *
140            * @param dynamicQuery the dynamic query
141            * @param start the lower bound of the range of model instances
142            * @param end the upper bound of the range of model instances (not inclusive)
143            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
144            * @return the ordered range of matching rows
145            * @throws SystemException if a system exception occurred
146            */
147            @SuppressWarnings("rawtypes")
148            public static java.util.List dynamicQuery(
149                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
150                    int end,
151                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
152                    throws com.liferay.portal.kernel.exception.SystemException {
153                    return getService()
154                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
155            }
156    
157            /**
158            * Returns the number of rows that match the dynamic query.
159            *
160            * @param dynamicQuery the dynamic query
161            * @return the number of rows that match the dynamic query
162            * @throws SystemException if a system exception occurred
163            */
164            public static long dynamicQueryCount(
165                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
166                    throws com.liferay.portal.kernel.exception.SystemException {
167                    return getService().dynamicQueryCount(dynamicQuery);
168            }
169    
170            /**
171            * Returns the number of rows that match the dynamic query.
172            *
173            * @param dynamicQuery the dynamic query
174            * @param projection the projection to apply to the query
175            * @return the number of rows that match the dynamic query
176            * @throws SystemException if a system exception occurred
177            */
178            public static long dynamicQueryCount(
179                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
180                    com.liferay.portal.kernel.dao.orm.Projection projection)
181                    throws com.liferay.portal.kernel.exception.SystemException {
182                    return getService().dynamicQueryCount(dynamicQuery, projection);
183            }
184    
185            public static com.liferay.portal.model.WorkflowInstanceLink fetchWorkflowInstanceLink(
186                    long workflowInstanceLinkId)
187                    throws com.liferay.portal.kernel.exception.SystemException {
188                    return getService().fetchWorkflowInstanceLink(workflowInstanceLinkId);
189            }
190    
191            /**
192            * Returns the workflow instance link with the primary key.
193            *
194            * @param workflowInstanceLinkId the primary key of the workflow instance link
195            * @return the workflow instance link
196            * @throws PortalException if a workflow instance link with the primary key could not be found
197            * @throws SystemException if a system exception occurred
198            */
199            public static com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink(
200                    long workflowInstanceLinkId)
201                    throws com.liferay.portal.kernel.exception.PortalException,
202                            com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getWorkflowInstanceLink(workflowInstanceLinkId);
204            }
205    
206            public static com.liferay.portal.model.PersistedModel getPersistedModel(
207                    java.io.Serializable primaryKeyObj)
208                    throws com.liferay.portal.kernel.exception.PortalException,
209                            com.liferay.portal.kernel.exception.SystemException {
210                    return getService().getPersistedModel(primaryKeyObj);
211            }
212    
213            /**
214            * Returns a range of all the workflow instance links.
215            *
216            * <p>
217            * 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.
218            * </p>
219            *
220            * @param start the lower bound of the range of workflow instance links
221            * @param end the upper bound of the range of workflow instance links (not inclusive)
222            * @return the range of workflow instance links
223            * @throws SystemException if a system exception occurred
224            */
225            public static java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks(
226                    int start, int end)
227                    throws com.liferay.portal.kernel.exception.SystemException {
228                    return getService().getWorkflowInstanceLinks(start, end);
229            }
230    
231            /**
232            * Returns the number of workflow instance links.
233            *
234            * @return the number of workflow instance links
235            * @throws SystemException if a system exception occurred
236            */
237            public static int getWorkflowInstanceLinksCount()
238                    throws com.liferay.portal.kernel.exception.SystemException {
239                    return getService().getWorkflowInstanceLinksCount();
240            }
241    
242            /**
243            * Updates the workflow instance link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
244            *
245            * @param workflowInstanceLink the workflow instance link
246            * @return the workflow instance link that was updated
247            * @throws SystemException if a system exception occurred
248            */
249            public static com.liferay.portal.model.WorkflowInstanceLink updateWorkflowInstanceLink(
250                    com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink)
251                    throws com.liferay.portal.kernel.exception.SystemException {
252                    return getService().updateWorkflowInstanceLink(workflowInstanceLink);
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 com.liferay.portal.model.WorkflowInstanceLink deleteWorkflowInstanceLink(
284                    long companyId, long groupId, java.lang.String className, long classPK)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException {
287                    return getService()
288                                       .deleteWorkflowInstanceLink(companyId, groupId, className,
289                            classPK);
290            }
291    
292            public static void deleteWorkflowInstanceLinks(long companyId,
293                    long groupId, java.lang.String className, long classPK)
294                    throws com.liferay.portal.kernel.exception.PortalException,
295                            com.liferay.portal.kernel.exception.SystemException {
296                    getService()
297                            .deleteWorkflowInstanceLinks(companyId, groupId, className, classPK);
298            }
299    
300            public static com.liferay.portal.model.WorkflowInstanceLink fetchWorkflowInstanceLink(
301                    long companyId, long groupId, java.lang.String className, long classPK)
302                    throws com.liferay.portal.kernel.exception.SystemException {
303                    return getService()
304                                       .fetchWorkflowInstanceLink(companyId, groupId, className,
305                            classPK);
306            }
307    
308            public static java.lang.String getState(long companyId, long groupId,
309                    java.lang.String className, long classPK)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException {
312                    return getService().getState(companyId, groupId, className, classPK);
313            }
314    
315            public static com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink(
316                    long companyId, long groupId, java.lang.String className, long classPK)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException {
319                    return getService()
320                                       .getWorkflowInstanceLink(companyId, groupId, className,
321                            classPK);
322            }
323    
324            public static java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks(
325                    long companyId, long groupId, java.lang.String className, long classPK)
326                    throws com.liferay.portal.kernel.exception.SystemException {
327                    return getService()
328                                       .getWorkflowInstanceLinks(companyId, groupId, className,
329                            classPK);
330            }
331    
332            public static boolean hasWorkflowInstanceLink(long companyId, long groupId,
333                    java.lang.String className, long classPK)
334                    throws com.liferay.portal.kernel.exception.SystemException {
335                    return getService()
336                                       .hasWorkflowInstanceLink(companyId, groupId, className,
337                            classPK);
338            }
339    
340            public static boolean isEnded(long companyId, long groupId,
341                    java.lang.String className, long classPK)
342                    throws com.liferay.portal.kernel.exception.PortalException,
343                            com.liferay.portal.kernel.exception.SystemException {
344                    return getService().isEnded(companyId, groupId, className, classPK);
345            }
346    
347            public static void startWorkflowInstance(long companyId, long groupId,
348                    long userId, java.lang.String className, long classPK,
349                    java.util.Map<java.lang.String, java.io.Serializable> workflowContext)
350                    throws com.liferay.portal.kernel.exception.PortalException,
351                            com.liferay.portal.kernel.exception.SystemException {
352                    getService()
353                            .startWorkflowInstance(companyId, groupId, userId, className,
354                            classPK, workflowContext);
355            }
356    
357            public static void updateClassPK(long companyId, long groupId,
358                    java.lang.String className, long oldClassPK, long newClassPK)
359                    throws com.liferay.portal.kernel.exception.PortalException,
360                            com.liferay.portal.kernel.exception.SystemException {
361                    getService()
362                            .updateClassPK(companyId, groupId, className, oldClassPK, newClassPK);
363            }
364    
365            public static WorkflowInstanceLinkLocalService getService() {
366                    if (_service == null) {
367                            _service = (WorkflowInstanceLinkLocalService)PortalBeanLocatorUtil.locate(WorkflowInstanceLinkLocalService.class.getName());
368    
369                            ReferenceRegistry.registerReference(WorkflowInstanceLinkLocalServiceUtil.class,
370                                    "_service");
371                    }
372    
373                    return _service;
374            }
375    
376            /**
377             * @deprecated As of 6.2.0
378             */
379            public void setService(WorkflowInstanceLinkLocalService service) {
380            }
381    
382            private static WorkflowInstanceLinkLocalService _service;
383    }