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.http;
016    
017    import com.liferay.portal.kernel.log.Log;
018    import com.liferay.portal.kernel.log.LogFactoryUtil;
019    import com.liferay.portal.kernel.util.ListUtil;
020    
021    import com.liferay.portlet.documentlibrary.service.DLFileEntryServiceUtil;
022    
023    import java.rmi.RemoteException;
024    
025    /**
026     * <p>
027     * This class provides a SOAP utility for the
028     * {@link com.liferay.portlet.documentlibrary.service.DLFileEntryServiceUtil} service utility. The
029     * static methods of this class calls the same methods of the service utility.
030     * However, the signatures are different because it is difficult for SOAP to
031     * support certain types.
032     * </p>
033     *
034     * <p>
035     * ServiceBuilder follows certain rules in translating the methods. For example,
036     * if the method in the service utility returns a {@link java.util.List}, that
037     * is translated to an array of {@link com.liferay.portlet.documentlibrary.model.DLFileEntrySoap}.
038     * If the method in the service utility returns a
039     * {@link com.liferay.portlet.documentlibrary.model.DLFileEntry}, that is translated to a
040     * {@link com.liferay.portlet.documentlibrary.model.DLFileEntrySoap}. Methods that SOAP cannot
041     * safely wire are skipped.
042     * </p>
043     *
044     * <p>
045     * The benefits of using the SOAP utility is that it is cross platform
046     * compatible. SOAP allows different languages like Java, .NET, C++, PHP, and
047     * even Perl, to call the generated services. One drawback of SOAP is that it is
048     * slow because it needs to serialize all calls into a text format (XML).
049     * </p>
050     *
051     * <p>
052     * You can see a list of services at
053     * http://localhost:8080/api/secure/axis. Set the property
054     * <b>axis.servlet.hosts.allowed</b> in portal.properties to configure
055     * security.
056     * </p>
057     *
058     * <p>
059     * The SOAP utility is only generated for remote services.
060     * </p>
061     *
062     * @author    Brian Wing Shun Chan
063     * @see       DLFileEntryServiceHttp
064     * @see       com.liferay.portlet.documentlibrary.model.DLFileEntrySoap
065     * @see       com.liferay.portlet.documentlibrary.service.DLFileEntryServiceUtil
066     * @generated
067     */
068    public class DLFileEntryServiceSoap {
069            public static com.liferay.portlet.documentlibrary.model.DLFileVersionSoap cancelCheckOut(
070                    long fileEntryId) throws RemoteException {
071                    try {
072                            com.liferay.portlet.documentlibrary.model.DLFileVersion returnValue = DLFileEntryServiceUtil.cancelCheckOut(fileEntryId);
073    
074                            return com.liferay.portlet.documentlibrary.model.DLFileVersionSoap.toSoapModel(returnValue);
075                    }
076                    catch (Exception e) {
077                            _log.error(e, e);
078    
079                            throw new RemoteException(e.getMessage());
080                    }
081            }
082    
083            public static void checkInFileEntry(long fileEntryId, boolean major,
084                    java.lang.String changeLog,
085                    com.liferay.portal.service.ServiceContext serviceContext)
086                    throws RemoteException {
087                    try {
088                            DLFileEntryServiceUtil.checkInFileEntry(fileEntryId, major,
089                                    changeLog, serviceContext);
090                    }
091                    catch (Exception e) {
092                            _log.error(e, e);
093    
094                            throw new RemoteException(e.getMessage());
095                    }
096            }
097    
098            public static void checkInFileEntry(long fileEntryId,
099                    java.lang.String lockUuid) throws RemoteException {
100                    try {
101                            DLFileEntryServiceUtil.checkInFileEntry(fileEntryId, lockUuid);
102                    }
103                    catch (Exception e) {
104                            _log.error(e, e);
105    
106                            throw new RemoteException(e.getMessage());
107                    }
108            }
109    
110            /**
111            * @deprecated {@link #checkOutFileEntry(long, ServiceContext)}
112            */
113            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap checkOutFileEntry(
114                    long fileEntryId) throws RemoteException {
115                    try {
116                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.checkOutFileEntry(fileEntryId);
117    
118                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
119                    }
120                    catch (Exception e) {
121                            _log.error(e, e);
122    
123                            throw new RemoteException(e.getMessage());
124                    }
125            }
126    
127            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap checkOutFileEntry(
128                    long fileEntryId,
129                    com.liferay.portal.service.ServiceContext serviceContext)
130                    throws RemoteException {
131                    try {
132                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.checkOutFileEntry(fileEntryId,
133                                            serviceContext);
134    
135                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
136                    }
137                    catch (Exception e) {
138                            _log.error(e, e);
139    
140                            throw new RemoteException(e.getMessage());
141                    }
142            }
143    
144            /**
145            * @deprecated {@link #checkOutFileEntry(long, String, long,
146            ServiceContext)}
147            */
148            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap checkOutFileEntry(
149                    long fileEntryId, java.lang.String owner, long expirationTime)
150                    throws RemoteException {
151                    try {
152                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.checkOutFileEntry(fileEntryId,
153                                            owner, expirationTime);
154    
155                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
156                    }
157                    catch (Exception e) {
158                            _log.error(e, e);
159    
160                            throw new RemoteException(e.getMessage());
161                    }
162            }
163    
164            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap checkOutFileEntry(
165                    long fileEntryId, java.lang.String owner, long expirationTime,
166                    com.liferay.portal.service.ServiceContext serviceContext)
167                    throws RemoteException {
168                    try {
169                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.checkOutFileEntry(fileEntryId,
170                                            owner, expirationTime, serviceContext);
171    
172                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
173                    }
174                    catch (Exception e) {
175                            _log.error(e, e);
176    
177                            throw new RemoteException(e.getMessage());
178                    }
179            }
180    
181            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap copyFileEntry(
182                    long groupId, long repositoryId, long fileEntryId, long destFolderId,
183                    com.liferay.portal.service.ServiceContext serviceContext)
184                    throws RemoteException {
185                    try {
186                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.copyFileEntry(groupId,
187                                            repositoryId, fileEntryId, destFolderId, serviceContext);
188    
189                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
190                    }
191                    catch (Exception e) {
192                            _log.error(e, e);
193    
194                            throw new RemoteException(e.getMessage());
195                    }
196            }
197    
198            public static void deleteFileEntry(long fileEntryId)
199                    throws RemoteException {
200                    try {
201                            DLFileEntryServiceUtil.deleteFileEntry(fileEntryId);
202                    }
203                    catch (Exception e) {
204                            _log.error(e, e);
205    
206                            throw new RemoteException(e.getMessage());
207                    }
208            }
209    
210            public static void deleteFileEntry(long groupId, long folderId,
211                    java.lang.String title) throws RemoteException {
212                    try {
213                            DLFileEntryServiceUtil.deleteFileEntry(groupId, folderId, title);
214                    }
215                    catch (Exception e) {
216                            _log.error(e, e);
217    
218                            throw new RemoteException(e.getMessage());
219                    }
220            }
221    
222            public static void deleteFileVersion(long fileEntryId,
223                    java.lang.String version) throws RemoteException {
224                    try {
225                            DLFileEntryServiceUtil.deleteFileVersion(fileEntryId, version);
226                    }
227                    catch (Exception e) {
228                            _log.error(e, e);
229    
230                            throw new RemoteException(e.getMessage());
231                    }
232            }
233    
234            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap fetchFileEntryByImageId(
235                    long imageId) throws RemoteException {
236                    try {
237                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.fetchFileEntryByImageId(imageId);
238    
239                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
240                    }
241                    catch (Exception e) {
242                            _log.error(e, e);
243    
244                            throw new RemoteException(e.getMessage());
245                    }
246            }
247    
248            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getFileEntries(
249                    long groupId, long folderId, int start, int end,
250                    com.liferay.portal.kernel.util.OrderByComparator obc)
251                    throws RemoteException {
252                    try {
253                            java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> returnValue =
254                                    DLFileEntryServiceUtil.getFileEntries(groupId, folderId, start,
255                                            end, obc);
256    
257                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModels(returnValue);
258                    }
259                    catch (Exception e) {
260                            _log.error(e, e);
261    
262                            throw new RemoteException(e.getMessage());
263                    }
264            }
265    
266            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getFileEntries(
267                    long groupId, long folderId, long fileEntryTypeId, int start, int end,
268                    com.liferay.portal.kernel.util.OrderByComparator obc)
269                    throws RemoteException {
270                    try {
271                            java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> returnValue =
272                                    DLFileEntryServiceUtil.getFileEntries(groupId, folderId,
273                                            fileEntryTypeId, start, end, obc);
274    
275                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModels(returnValue);
276                    }
277                    catch (Exception e) {
278                            _log.error(e, e);
279    
280                            throw new RemoteException(e.getMessage());
281                    }
282            }
283    
284            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getFileEntries(
285                    long groupId, long folderId, java.lang.String[] mimeTypes, int start,
286                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
287                    throws RemoteException {
288                    try {
289                            java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> returnValue =
290                                    DLFileEntryServiceUtil.getFileEntries(groupId, folderId,
291                                            mimeTypes, start, end, obc);
292    
293                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModels(returnValue);
294                    }
295                    catch (Exception e) {
296                            _log.error(e, e);
297    
298                            throw new RemoteException(e.getMessage());
299                    }
300            }
301    
302            public static int getFileEntriesCount(long groupId, long folderId)
303                    throws RemoteException {
304                    try {
305                            int returnValue = DLFileEntryServiceUtil.getFileEntriesCount(groupId,
306                                            folderId);
307    
308                            return returnValue;
309                    }
310                    catch (Exception e) {
311                            _log.error(e, e);
312    
313                            throw new RemoteException(e.getMessage());
314                    }
315            }
316    
317            public static int getFileEntriesCount(long groupId, long folderId,
318                    long fileEntryTypeId) throws RemoteException {
319                    try {
320                            int returnValue = DLFileEntryServiceUtil.getFileEntriesCount(groupId,
321                                            folderId, fileEntryTypeId);
322    
323                            return returnValue;
324                    }
325                    catch (Exception e) {
326                            _log.error(e, e);
327    
328                            throw new RemoteException(e.getMessage());
329                    }
330            }
331    
332            public static int getFileEntriesCount(long groupId, long folderId,
333                    java.lang.String[] mimeTypes) throws RemoteException {
334                    try {
335                            int returnValue = DLFileEntryServiceUtil.getFileEntriesCount(groupId,
336                                            folderId, mimeTypes);
337    
338                            return returnValue;
339                    }
340                    catch (Exception e) {
341                            _log.error(e, e);
342    
343                            throw new RemoteException(e.getMessage());
344                    }
345            }
346    
347            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap getFileEntry(
348                    long fileEntryId) throws RemoteException {
349                    try {
350                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.getFileEntry(fileEntryId);
351    
352                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
353                    }
354                    catch (Exception e) {
355                            _log.error(e, e);
356    
357                            throw new RemoteException(e.getMessage());
358                    }
359            }
360    
361            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap getFileEntry(
362                    long groupId, long folderId, java.lang.String title)
363                    throws RemoteException {
364                    try {
365                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.getFileEntry(groupId,
366                                            folderId, title);
367    
368                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
369                    }
370                    catch (Exception e) {
371                            _log.error(e, e);
372    
373                            throw new RemoteException(e.getMessage());
374                    }
375            }
376    
377            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap getFileEntryByUuidAndGroupId(
378                    java.lang.String uuid, long groupId) throws RemoteException {
379                    try {
380                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.getFileEntryByUuidAndGroupId(uuid,
381                                            groupId);
382    
383                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
384                    }
385                    catch (Exception e) {
386                            _log.error(e, e);
387    
388                            throw new RemoteException(e.getMessage());
389                    }
390            }
391    
392            public static int getFoldersFileEntriesCount(long groupId,
393                    Long[] folderIds, int status) throws RemoteException {
394                    try {
395                            int returnValue = DLFileEntryServiceUtil.getFoldersFileEntriesCount(groupId,
396                                            ListUtil.toList(folderIds), status);
397    
398                            return returnValue;
399                    }
400                    catch (Exception e) {
401                            _log.error(e, e);
402    
403                            throw new RemoteException(e.getMessage());
404                    }
405            }
406    
407            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getGroupFileEntries(
408                    long groupId, long userId, long rootFolderId, int start, int end,
409                    com.liferay.portal.kernel.util.OrderByComparator obc)
410                    throws RemoteException {
411                    try {
412                            java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> returnValue =
413                                    DLFileEntryServiceUtil.getGroupFileEntries(groupId, userId,
414                                            rootFolderId, start, end, obc);
415    
416                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModels(returnValue);
417                    }
418                    catch (Exception e) {
419                            _log.error(e, e);
420    
421                            throw new RemoteException(e.getMessage());
422                    }
423            }
424    
425            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getGroupFileEntries(
426                    long groupId, long userId, long rootFolderId,
427                    java.lang.String[] mimeTypes, int status, int start, int end,
428                    com.liferay.portal.kernel.util.OrderByComparator obc)
429                    throws RemoteException {
430                    try {
431                            java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> returnValue =
432                                    DLFileEntryServiceUtil.getGroupFileEntries(groupId, userId,
433                                            rootFolderId, mimeTypes, status, start, end, obc);
434    
435                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModels(returnValue);
436                    }
437                    catch (Exception e) {
438                            _log.error(e, e);
439    
440                            throw new RemoteException(e.getMessage());
441                    }
442            }
443    
444            public static int getGroupFileEntriesCount(long groupId, long userId,
445                    long rootFolderId) throws RemoteException {
446                    try {
447                            int returnValue = DLFileEntryServiceUtil.getGroupFileEntriesCount(groupId,
448                                            userId, rootFolderId);
449    
450                            return returnValue;
451                    }
452                    catch (Exception e) {
453                            _log.error(e, e);
454    
455                            throw new RemoteException(e.getMessage());
456                    }
457            }
458    
459            public static int getGroupFileEntriesCount(long groupId, long userId,
460                    long rootFolderId, java.lang.String[] mimeTypes, int status)
461                    throws RemoteException {
462                    try {
463                            int returnValue = DLFileEntryServiceUtil.getGroupFileEntriesCount(groupId,
464                                            userId, rootFolderId, mimeTypes, status);
465    
466                            return returnValue;
467                    }
468                    catch (Exception e) {
469                            _log.error(e, e);
470    
471                            throw new RemoteException(e.getMessage());
472                    }
473            }
474    
475            public static boolean hasFileEntryLock(long fileEntryId)
476                    throws RemoteException {
477                    try {
478                            boolean returnValue = DLFileEntryServiceUtil.hasFileEntryLock(fileEntryId);
479    
480                            return returnValue;
481                    }
482                    catch (Exception e) {
483                            _log.error(e, e);
484    
485                            throw new RemoteException(e.getMessage());
486                    }
487            }
488    
489            public static boolean isFileEntryCheckedOut(long fileEntryId)
490                    throws RemoteException {
491                    try {
492                            boolean returnValue = DLFileEntryServiceUtil.isFileEntryCheckedOut(fileEntryId);
493    
494                            return returnValue;
495                    }
496                    catch (Exception e) {
497                            _log.error(e, e);
498    
499                            throw new RemoteException(e.getMessage());
500                    }
501            }
502    
503            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap moveFileEntry(
504                    long fileEntryId, long newFolderId,
505                    com.liferay.portal.service.ServiceContext serviceContext)
506                    throws RemoteException {
507                    try {
508                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.moveFileEntry(fileEntryId,
509                                            newFolderId, serviceContext);
510    
511                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
512                    }
513                    catch (Exception e) {
514                            _log.error(e, e);
515    
516                            throw new RemoteException(e.getMessage());
517                    }
518            }
519    
520            public static void revertFileEntry(long fileEntryId,
521                    java.lang.String version,
522                    com.liferay.portal.service.ServiceContext serviceContext)
523                    throws RemoteException {
524                    try {
525                            DLFileEntryServiceUtil.revertFileEntry(fileEntryId, version,
526                                    serviceContext);
527                    }
528                    catch (Exception e) {
529                            _log.error(e, e);
530    
531                            throw new RemoteException(e.getMessage());
532                    }
533            }
534    
535            public static boolean verifyFileEntryCheckOut(long fileEntryId,
536                    java.lang.String lockUuid) throws RemoteException {
537                    try {
538                            boolean returnValue = DLFileEntryServiceUtil.verifyFileEntryCheckOut(fileEntryId,
539                                            lockUuid);
540    
541                            return returnValue;
542                    }
543                    catch (Exception e) {
544                            _log.error(e, e);
545    
546                            throw new RemoteException(e.getMessage());
547                    }
548            }
549    
550            public static boolean verifyFileEntryLock(long fileEntryId,
551                    java.lang.String lockUuid) throws RemoteException {
552                    try {
553                            boolean returnValue = DLFileEntryServiceUtil.verifyFileEntryLock(fileEntryId,
554                                            lockUuid);
555    
556                            return returnValue;
557                    }
558                    catch (Exception e) {
559                            _log.error(e, e);
560    
561                            throw new RemoteException(e.getMessage());
562                    }
563            }
564    
565            private static Log _log = LogFactoryUtil.getLog(DLFileEntryServiceSoap.class);
566    }