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.portlet.documentlibrary.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 d l sync local service. This utility wraps {@link com.liferay.portlet.documentlibrary.service.impl.DLSyncLocalServiceImpl} 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 DLSyncLocalService
030     * @see com.liferay.portlet.documentlibrary.service.base.DLSyncLocalServiceBaseImpl
031     * @see com.liferay.portlet.documentlibrary.service.impl.DLSyncLocalServiceImpl
032     * @generated
033     */
034    public class DLSyncLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLSyncLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the d l sync to the database. Also notifies the appropriate model listeners.
043            *
044            * @param dlSync the d l sync
045            * @return the d l sync that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.documentlibrary.model.DLSync addDLSync(
049                    com.liferay.portlet.documentlibrary.model.DLSync dlSync)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addDLSync(dlSync);
052            }
053    
054            /**
055            * Creates a new d l sync with the primary key. Does not add the d l sync to the database.
056            *
057            * @param syncId the primary key for the new d l sync
058            * @return the new d l sync
059            */
060            public static com.liferay.portlet.documentlibrary.model.DLSync createDLSync(
061                    long syncId) {
062                    return getService().createDLSync(syncId);
063            }
064    
065            /**
066            * Deletes the d l sync with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param syncId the primary key of the d l sync
069            * @throws PortalException if a d l sync with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteDLSync(long syncId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteDLSync(syncId);
076            }
077    
078            /**
079            * Deletes the d l sync from the database. Also notifies the appropriate model listeners.
080            *
081            * @param dlSync the d l sync
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteDLSync(
085                    com.liferay.portlet.documentlibrary.model.DLSync dlSync)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteDLSync(dlSync);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * 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.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * 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.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            public static com.liferay.portlet.documentlibrary.model.DLSync fetchDLSync(
162                    long syncId) throws com.liferay.portal.kernel.exception.SystemException {
163                    return getService().fetchDLSync(syncId);
164            }
165    
166            /**
167            * Returns the d l sync with the primary key.
168            *
169            * @param syncId the primary key of the d l sync
170            * @return the d l sync
171            * @throws PortalException if a d l sync with the primary key could not be found
172            * @throws SystemException if a system exception occurred
173            */
174            public static com.liferay.portlet.documentlibrary.model.DLSync getDLSync(
175                    long syncId)
176                    throws com.liferay.portal.kernel.exception.PortalException,
177                            com.liferay.portal.kernel.exception.SystemException {
178                    return getService().getDLSync(syncId);
179            }
180    
181            public static com.liferay.portal.model.PersistedModel getPersistedModel(
182                    java.io.Serializable primaryKeyObj)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getPersistedModel(primaryKeyObj);
186            }
187    
188            /**
189            * Returns a range of all the d l syncs.
190            *
191            * <p>
192            * 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.
193            * </p>
194            *
195            * @param start the lower bound of the range of d l syncs
196            * @param end the upper bound of the range of d l syncs (not inclusive)
197            * @return the range of d l syncs
198            * @throws SystemException if a system exception occurred
199            */
200            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLSync> getDLSyncs(
201                    int start, int end)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getDLSyncs(start, end);
204            }
205    
206            /**
207            * Returns the number of d l syncs.
208            *
209            * @return the number of d l syncs
210            * @throws SystemException if a system exception occurred
211            */
212            public static int getDLSyncsCount()
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getDLSyncsCount();
215            }
216    
217            /**
218            * Updates the d l sync in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
219            *
220            * @param dlSync the d l sync
221            * @return the d l sync that was updated
222            * @throws SystemException if a system exception occurred
223            */
224            public static com.liferay.portlet.documentlibrary.model.DLSync updateDLSync(
225                    com.liferay.portlet.documentlibrary.model.DLSync dlSync)
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    return getService().updateDLSync(dlSync);
228            }
229    
230            /**
231            * Updates the d l sync in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
232            *
233            * @param dlSync the d l sync
234            * @param merge whether to merge the d l sync 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.
235            * @return the d l sync that was updated
236            * @throws SystemException if a system exception occurred
237            */
238            public static com.liferay.portlet.documentlibrary.model.DLSync updateDLSync(
239                    com.liferay.portlet.documentlibrary.model.DLSync dlSync, boolean merge)
240                    throws com.liferay.portal.kernel.exception.SystemException {
241                    return getService().updateDLSync(dlSync, merge);
242            }
243    
244            /**
245            * Returns the Spring bean ID for this bean.
246            *
247            * @return the Spring bean ID for this bean
248            */
249            public static java.lang.String getBeanIdentifier() {
250                    return getService().getBeanIdentifier();
251            }
252    
253            /**
254            * Sets the Spring bean ID for this bean.
255            *
256            * @param beanIdentifier the Spring bean ID for this bean
257            */
258            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
259                    getService().setBeanIdentifier(beanIdentifier);
260            }
261    
262            /**
263            * @deprecated {@link #addSync(long, String, long, long, long, String,
264            String, String, String)}
265            */
266            public static com.liferay.portlet.documentlibrary.model.DLSync addSync(
267                    long fileId, java.lang.String fileUuid, long companyId,
268                    long repositoryId, long parentFolderId, java.lang.String name,
269                    java.lang.String type, java.lang.String version)
270                    throws com.liferay.portal.kernel.exception.SystemException {
271                    return getService()
272                                       .addSync(fileId, fileUuid, companyId, repositoryId,
273                            parentFolderId, name, type, version);
274            }
275    
276            public static com.liferay.portlet.documentlibrary.model.DLSync addSync(
277                    long fileId, java.lang.String fileUuid, long companyId,
278                    long repositoryId, long parentFolderId, java.lang.String name,
279                    java.lang.String description, java.lang.String type,
280                    java.lang.String version)
281                    throws com.liferay.portal.kernel.exception.SystemException {
282                    return getService()
283                                       .addSync(fileId, fileUuid, companyId, repositoryId,
284                            parentFolderId, name, description, type, version);
285            }
286    
287            /**
288            * @deprecated {@link #updateSync(long, long, String, String, String,
289            String)}
290            */
291            public static com.liferay.portlet.documentlibrary.model.DLSync updateSync(
292                    long fileId, long parentFolderId, java.lang.String name,
293                    java.lang.String event, java.lang.String version)
294                    throws com.liferay.portal.kernel.exception.PortalException,
295                            com.liferay.portal.kernel.exception.SystemException {
296                    return getService()
297                                       .updateSync(fileId, parentFolderId, name, event, version);
298            }
299    
300            public static com.liferay.portlet.documentlibrary.model.DLSync updateSync(
301                    long fileId, long parentFolderId, java.lang.String name,
302                    java.lang.String description, java.lang.String event,
303                    java.lang.String version)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException {
306                    return getService()
307                                       .updateSync(fileId, parentFolderId, name, description,
308                            event, version);
309            }
310    
311            public static DLSyncLocalService getService() {
312                    if (_service == null) {
313                            _service = (DLSyncLocalService)PortalBeanLocatorUtil.locate(DLSyncLocalService.class.getName());
314    
315                            ReferenceRegistry.registerReference(DLSyncLocalServiceUtil.class,
316                                    "_service");
317                            MethodCache.remove(DLSyncLocalService.class);
318                    }
319    
320                    return _service;
321            }
322    
323            public void setService(DLSyncLocalService service) {
324                    MethodCache.remove(DLSyncLocalService.class);
325    
326                    _service = service;
327    
328                    ReferenceRegistry.registerReference(DLSyncLocalServiceUtil.class,
329                            "_service");
330                    MethodCache.remove(DLSyncLocalService.class);
331            }
332    
333            private static DLSyncLocalService _service;
334    }