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