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.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. 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.
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. 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.
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. 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.
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            * Returns the Spring bean ID for this bean.
241            *
242            * @return the Spring bean ID for this bean
243            */
244            public static java.lang.String getBeanIdentifier() {
245                    return getService().getBeanIdentifier();
246            }
247    
248            /**
249            * Sets the Spring bean ID for this bean.
250            *
251            * @param beanIdentifier the Spring bean ID for this bean
252            */
253            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
254                    getService().setBeanIdentifier(beanIdentifier);
255            }
256    
257            public static com.liferay.portal.model.WorkflowInstanceLink addWorkflowInstanceLink(
258                    long userId, long companyId, long groupId, java.lang.String className,
259                    long classPK, long workflowInstanceId)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException {
262                    return getService()
263                                       .addWorkflowInstanceLink(userId, companyId, groupId,
264                            className, classPK, workflowInstanceId);
265            }
266    
267            public static com.liferay.portal.model.WorkflowInstanceLink deleteWorkflowInstanceLink(
268                    long companyId, long groupId, java.lang.String className, long classPK)
269                    throws com.liferay.portal.kernel.exception.PortalException,
270                            com.liferay.portal.kernel.exception.SystemException {
271                    return getService()
272                                       .deleteWorkflowInstanceLink(companyId, groupId, className,
273                            classPK);
274            }
275    
276            public static void deleteWorkflowInstanceLinks(long companyId,
277                    long groupId, java.lang.String className, long classPK)
278                    throws com.liferay.portal.kernel.exception.PortalException,
279                            com.liferay.portal.kernel.exception.SystemException {
280                    getService()
281                            .deleteWorkflowInstanceLinks(companyId, groupId, className, classPK);
282            }
283    
284            public static com.liferay.portal.model.WorkflowInstanceLink fetchWorkflowInstanceLink(
285                    long companyId, long groupId, java.lang.String className, long classPK)
286                    throws com.liferay.portal.kernel.exception.SystemException {
287                    return getService()
288                                       .fetchWorkflowInstanceLink(companyId, groupId, className,
289                            classPK);
290            }
291    
292            public static java.lang.String getState(long companyId, long groupId,
293                    java.lang.String className, long classPK)
294                    throws com.liferay.portal.kernel.exception.PortalException,
295                            com.liferay.portal.kernel.exception.SystemException {
296                    return getService().getState(companyId, groupId, className, classPK);
297            }
298    
299            public static com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink(
300                    long companyId, long groupId, java.lang.String className, long classPK)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException {
303                    return getService()
304                                       .getWorkflowInstanceLink(companyId, groupId, className,
305                            classPK);
306            }
307    
308            public static java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks(
309                    long companyId, long groupId, java.lang.String className, long classPK)
310                    throws com.liferay.portal.kernel.exception.SystemException {
311                    return getService()
312                                       .getWorkflowInstanceLinks(companyId, groupId, className,
313                            classPK);
314            }
315    
316            public static boolean hasWorkflowInstanceLink(long companyId, long groupId,
317                    java.lang.String className, long classPK)
318                    throws com.liferay.portal.kernel.exception.SystemException {
319                    return getService()
320                                       .hasWorkflowInstanceLink(companyId, groupId, className,
321                            classPK);
322            }
323    
324            public static boolean isEnded(long companyId, long groupId,
325                    java.lang.String className, long classPK)
326                    throws com.liferay.portal.kernel.exception.PortalException,
327                            com.liferay.portal.kernel.exception.SystemException {
328                    return getService().isEnded(companyId, groupId, className, classPK);
329            }
330    
331            public static void startWorkflowInstance(long companyId, long groupId,
332                    long userId, java.lang.String className, long classPK,
333                    java.util.Map<java.lang.String, java.io.Serializable> workflowContext)
334                    throws com.liferay.portal.kernel.exception.PortalException,
335                            com.liferay.portal.kernel.exception.SystemException {
336                    getService()
337                            .startWorkflowInstance(companyId, groupId, userId, className,
338                            classPK, workflowContext);
339            }
340    
341            public static void updateClassPK(long companyId, long groupId,
342                    java.lang.String className, long oldClassPK, long newClassPK)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException {
345                    getService()
346                            .updateClassPK(companyId, groupId, className, oldClassPK, newClassPK);
347            }
348    
349            public static WorkflowInstanceLinkLocalService getService() {
350                    if (_service == null) {
351                            _service = (WorkflowInstanceLinkLocalService)PortalBeanLocatorUtil.locate(WorkflowInstanceLinkLocalService.class.getName());
352    
353                            ReferenceRegistry.registerReference(WorkflowInstanceLinkLocalServiceUtil.class,
354                                    "_service");
355                    }
356    
357                    return _service;
358            }
359    
360            /**
361             * @deprecated
362             */
363            public void setService(WorkflowInstanceLinkLocalService service) {
364            }
365    
366            private static WorkflowInstanceLinkLocalService _service;
367    }