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