001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    
019    /**
020     * 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.
021     *
022     * <p>
023     * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.WorkflowInstanceLinkLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
024     * </p>
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see WorkflowInstanceLinkLocalService
032     * @see com.liferay.portal.service.base.WorkflowInstanceLinkLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.WorkflowInstanceLinkLocalServiceImpl
034     * @generated
035     */
036    public class WorkflowInstanceLinkLocalServiceUtil {
037            /**
038            * Adds the workflow instance link to the database. Also notifies the appropriate model listeners.
039            *
040            * @param workflowInstanceLink the workflow instance link to add
041            * @return the workflow instance link that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portal.model.WorkflowInstanceLink addWorkflowInstanceLink(
045                    com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addWorkflowInstanceLink(workflowInstanceLink);
048            }
049    
050            /**
051            * Creates a new workflow instance link with the primary key. Does not add the workflow instance link to the database.
052            *
053            * @param workflowInstanceLinkId the primary key for the new workflow instance link
054            * @return the new workflow instance link
055            */
056            public static com.liferay.portal.model.WorkflowInstanceLink createWorkflowInstanceLink(
057                    long workflowInstanceLinkId) {
058                    return getService().createWorkflowInstanceLink(workflowInstanceLinkId);
059            }
060    
061            /**
062            * Deletes the workflow instance link with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param workflowInstanceLinkId the primary key of the workflow instance link to delete
065            * @throws PortalException if a workflow instance link with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteWorkflowInstanceLink(long workflowInstanceLinkId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteWorkflowInstanceLink(workflowInstanceLinkId);
072            }
073    
074            /**
075            * Deletes the workflow instance link from the database. Also notifies the appropriate model listeners.
076            *
077            * @param workflowInstanceLink the workflow instance link to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteWorkflowInstanceLink(
081                    com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteWorkflowInstanceLink(workflowInstanceLink);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * 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.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException {
117                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * 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.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the workflow instance link with the primary key.
159            *
160            * @param workflowInstanceLinkId the primary key of the workflow instance link to get
161            * @return the workflow instance link
162            * @throws PortalException if a workflow instance link with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink(
166                    long workflowInstanceLinkId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getWorkflowInstanceLink(workflowInstanceLinkId);
170            }
171    
172            /**
173            * Gets a range of all the workflow instance links.
174            *
175            * <p>
176            * 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.
177            * </p>
178            *
179            * @param start the lower bound of the range of workflow instance links to return
180            * @param end the upper bound of the range of workflow instance links to return (not inclusive)
181            * @return the range of workflow instance links
182            * @throws SystemException if a system exception occurred
183            */
184            public static java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks(
185                    int start, int end)
186                    throws com.liferay.portal.kernel.exception.SystemException {
187                    return getService().getWorkflowInstanceLinks(start, end);
188            }
189    
190            /**
191            * Gets the number of workflow instance links.
192            *
193            * @return the number of workflow instance links
194            * @throws SystemException if a system exception occurred
195            */
196            public static int getWorkflowInstanceLinksCount()
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getWorkflowInstanceLinksCount();
199            }
200    
201            /**
202            * Updates the workflow instance link in the database. Also notifies the appropriate model listeners.
203            *
204            * @param workflowInstanceLink the workflow instance link to update
205            * @return the workflow instance link that was updated
206            * @throws SystemException if a system exception occurred
207            */
208            public static com.liferay.portal.model.WorkflowInstanceLink updateWorkflowInstanceLink(
209                    com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink)
210                    throws com.liferay.portal.kernel.exception.SystemException {
211                    return getService().updateWorkflowInstanceLink(workflowInstanceLink);
212            }
213    
214            /**
215            * Updates the workflow instance link in the database. Also notifies the appropriate model listeners.
216            *
217            * @param workflowInstanceLink the workflow instance link to update
218            * @param merge whether to merge the workflow instance link with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
219            * @return the workflow instance link that was updated
220            * @throws SystemException if a system exception occurred
221            */
222            public static com.liferay.portal.model.WorkflowInstanceLink updateWorkflowInstanceLink(
223                    com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink,
224                    boolean merge)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService()
227                                       .updateWorkflowInstanceLink(workflowInstanceLink, merge);
228            }
229    
230            public static com.liferay.portal.model.WorkflowInstanceLink addWorkflowInstanceLink(
231                    long userId, long companyId, long groupId, java.lang.String className,
232                    long classPK, long workflowInstanceId)
233                    throws com.liferay.portal.kernel.exception.PortalException,
234                            com.liferay.portal.kernel.exception.SystemException {
235                    return getService()
236                                       .addWorkflowInstanceLink(userId, companyId, groupId,
237                            className, classPK, workflowInstanceId);
238            }
239    
240            public static void deleteWorkflowInstanceLink(long companyId, long groupId,
241                    java.lang.String className, long classPK)
242                    throws com.liferay.portal.kernel.exception.PortalException,
243                            com.liferay.portal.kernel.exception.SystemException {
244                    getService()
245                            .deleteWorkflowInstanceLink(companyId, groupId, className, classPK);
246            }
247    
248            public static void deleteWorkflowInstanceLinks(long companyId,
249                    long groupId, java.lang.String className, long classPK)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException {
252                    getService()
253                            .deleteWorkflowInstanceLinks(companyId, groupId, className, classPK);
254            }
255    
256            public static java.lang.String getState(long companyId, long groupId,
257                    java.lang.String className, long classPK)
258                    throws com.liferay.portal.kernel.exception.PortalException,
259                            com.liferay.portal.kernel.exception.SystemException {
260                    return getService().getState(companyId, groupId, className, classPK);
261            }
262    
263            public static com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink(
264                    long companyId, long groupId, java.lang.String className, long classPK)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException {
267                    return getService()
268                                       .getWorkflowInstanceLink(companyId, groupId, className,
269                            classPK);
270            }
271    
272            public static java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks(
273                    long companyId, long groupId, java.lang.String className, long classPK)
274                    throws com.liferay.portal.kernel.exception.SystemException {
275                    return getService()
276                                       .getWorkflowInstanceLinks(companyId, groupId, className,
277                            classPK);
278            }
279    
280            public static boolean hasWorkflowInstanceLink(long companyId, long groupId,
281                    java.lang.String className, long classPK)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException {
284                    return getService()
285                                       .hasWorkflowInstanceLink(companyId, groupId, className,
286                            classPK);
287            }
288    
289            public static boolean isEnded(long companyId, long groupId,
290                    java.lang.String className, long classPK)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException {
293                    return getService().isEnded(companyId, groupId, className, classPK);
294            }
295    
296            public static void startWorkflowInstance(long companyId, long groupId,
297                    long userId, java.lang.String className, long classPK,
298                    java.util.Map<java.lang.String, java.io.Serializable> workflowContext)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException {
301                    getService()
302                            .startWorkflowInstance(companyId, groupId, userId, className,
303                            classPK, workflowContext);
304            }
305    
306            public static void updateClassPK(long companyId, long groupId,
307                    java.lang.String className, long oldClassPK, long newClassPK)
308                    throws com.liferay.portal.kernel.exception.PortalException,
309                            com.liferay.portal.kernel.exception.SystemException {
310                    getService()
311                            .updateClassPK(companyId, groupId, className, oldClassPK, newClassPK);
312            }
313    
314            public static WorkflowInstanceLinkLocalService getService() {
315                    if (_service == null) {
316                            _service = (WorkflowInstanceLinkLocalService)PortalBeanLocatorUtil.locate(WorkflowInstanceLinkLocalService.class.getName());
317                    }
318    
319                    return _service;
320            }
321    
322            public void setService(WorkflowInstanceLinkLocalService service) {
323                    _service = service;
324            }
325    
326            private static WorkflowInstanceLinkLocalService _service;
327    }