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