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 http://localhost:8080/api/axis. Set the
053     * property <b>axis.servlet.hosts.allowed</b> in portal.properties to configure
054     * security.
055     * </p>
056     *
057     * <p>
058     * The SOAP utility is only generated for remote services.
059     * </p>
060     *
061     * @author    Brian Wing Shun Chan
062     * @see       DLFileEntryServiceHttp
063     * @see       com.liferay.portlet.documentlibrary.model.DLFileEntrySoap
064     * @see       com.liferay.portlet.documentlibrary.service.DLFileEntryServiceUtil
065     * @generated
066     */
067    public class DLFileEntryServiceSoap {
068            public static com.liferay.portlet.documentlibrary.model.DLFileVersionSoap cancelCheckOut(
069                    long fileEntryId) throws RemoteException {
070                    try {
071                            com.liferay.portlet.documentlibrary.model.DLFileVersion returnValue = DLFileEntryServiceUtil.cancelCheckOut(fileEntryId);
072    
073                            return com.liferay.portlet.documentlibrary.model.DLFileVersionSoap.toSoapModel(returnValue);
074                    }
075                    catch (Exception e) {
076                            _log.error(e, e);
077    
078                            throw new RemoteException(e.getMessage());
079                    }
080            }
081    
082            public static void checkInFileEntry(long fileEntryId, boolean major,
083                    java.lang.String changeLog,
084                    com.liferay.portal.service.ServiceContext serviceContext)
085                    throws RemoteException {
086                    try {
087                            DLFileEntryServiceUtil.checkInFileEntry(fileEntryId, major,
088                                    changeLog, serviceContext);
089                    }
090                    catch (Exception e) {
091                            _log.error(e, e);
092    
093                            throw new RemoteException(e.getMessage());
094                    }
095            }
096    
097            /**
098            * @deprecated As of 6.2.0, replaced by {@link #checkInFileEntry(long,
099            String, ServiceContext)}
100            */
101            public static void checkInFileEntry(long fileEntryId,
102                    java.lang.String lockUuid) throws RemoteException {
103                    try {
104                            DLFileEntryServiceUtil.checkInFileEntry(fileEntryId, lockUuid);
105                    }
106                    catch (Exception e) {
107                            _log.error(e, e);
108    
109                            throw new RemoteException(e.getMessage());
110                    }
111            }
112    
113            public static void checkInFileEntry(long fileEntryId,
114                    java.lang.String lockUuid,
115                    com.liferay.portal.service.ServiceContext serviceContext)
116                    throws RemoteException {
117                    try {
118                            DLFileEntryServiceUtil.checkInFileEntry(fileEntryId, lockUuid,
119                                    serviceContext);
120                    }
121                    catch (Exception e) {
122                            _log.error(e, e);
123    
124                            throw new RemoteException(e.getMessage());
125                    }
126            }
127    
128            /**
129            * @deprecated As of 6.2.0, replaced by {@link #checkOutFileEntry(long,
130            ServiceContext)}
131            */
132            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap checkOutFileEntry(
133                    long fileEntryId) throws RemoteException {
134                    try {
135                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.checkOutFileEntry(fileEntryId);
136    
137                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
138                    }
139                    catch (Exception e) {
140                            _log.error(e, e);
141    
142                            throw new RemoteException(e.getMessage());
143                    }
144            }
145    
146            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap checkOutFileEntry(
147                    long fileEntryId,
148                    com.liferay.portal.service.ServiceContext serviceContext)
149                    throws RemoteException {
150                    try {
151                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.checkOutFileEntry(fileEntryId,
152                                            serviceContext);
153    
154                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
155                    }
156                    catch (Exception e) {
157                            _log.error(e, e);
158    
159                            throw new RemoteException(e.getMessage());
160                    }
161            }
162    
163            /**
164            * @deprecated As of 6.2.0, replaced by {@link #checkOutFileEntry(long,
165            String, long, ServiceContext)}
166            */
167            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap checkOutFileEntry(
168                    long fileEntryId, java.lang.String owner, long expirationTime)
169                    throws RemoteException {
170                    try {
171                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.checkOutFileEntry(fileEntryId,
172                                            owner, expirationTime);
173    
174                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
175                    }
176                    catch (Exception e) {
177                            _log.error(e, e);
178    
179                            throw new RemoteException(e.getMessage());
180                    }
181            }
182    
183            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap checkOutFileEntry(
184                    long fileEntryId, java.lang.String owner, long expirationTime,
185                    com.liferay.portal.service.ServiceContext serviceContext)
186                    throws RemoteException {
187                    try {
188                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.checkOutFileEntry(fileEntryId,
189                                            owner, expirationTime, serviceContext);
190    
191                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
192                    }
193                    catch (Exception e) {
194                            _log.error(e, e);
195    
196                            throw new RemoteException(e.getMessage());
197                    }
198            }
199    
200            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap copyFileEntry(
201                    long groupId, long repositoryId, long fileEntryId, long destFolderId,
202                    com.liferay.portal.service.ServiceContext serviceContext)
203                    throws RemoteException {
204                    try {
205                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.copyFileEntry(groupId,
206                                            repositoryId, fileEntryId, destFolderId, serviceContext);
207    
208                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
209                    }
210                    catch (Exception e) {
211                            _log.error(e, e);
212    
213                            throw new RemoteException(e.getMessage());
214                    }
215            }
216    
217            public static void deleteFileEntry(long fileEntryId)
218                    throws RemoteException {
219                    try {
220                            DLFileEntryServiceUtil.deleteFileEntry(fileEntryId);
221                    }
222                    catch (Exception e) {
223                            _log.error(e, e);
224    
225                            throw new RemoteException(e.getMessage());
226                    }
227            }
228    
229            public static void deleteFileEntry(long groupId, long folderId,
230                    java.lang.String title) throws RemoteException {
231                    try {
232                            DLFileEntryServiceUtil.deleteFileEntry(groupId, folderId, title);
233                    }
234                    catch (Exception e) {
235                            _log.error(e, e);
236    
237                            throw new RemoteException(e.getMessage());
238                    }
239            }
240    
241            public static void deleteFileVersion(long fileEntryId,
242                    java.lang.String version) throws RemoteException {
243                    try {
244                            DLFileEntryServiceUtil.deleteFileVersion(fileEntryId, version);
245                    }
246                    catch (Exception e) {
247                            _log.error(e, e);
248    
249                            throw new RemoteException(e.getMessage());
250                    }
251            }
252    
253            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap fetchFileEntryByImageId(
254                    long imageId) throws RemoteException {
255                    try {
256                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.fetchFileEntryByImageId(imageId);
257    
258                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
259                    }
260                    catch (Exception e) {
261                            _log.error(e, e);
262    
263                            throw new RemoteException(e.getMessage());
264                    }
265            }
266    
267            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getFileEntries(
268                    long groupId, long folderId, int status, int start, int end,
269                    com.liferay.portal.kernel.util.OrderByComparator obc)
270                    throws RemoteException {
271                    try {
272                            java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> returnValue =
273                                    DLFileEntryServiceUtil.getFileEntries(groupId, folderId,
274                                            status, start, end, obc);
275    
276                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModels(returnValue);
277                    }
278                    catch (Exception e) {
279                            _log.error(e, e);
280    
281                            throw new RemoteException(e.getMessage());
282                    }
283            }
284    
285            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getFileEntries(
286                    long groupId, long folderId, int start, int end,
287                    com.liferay.portal.kernel.util.OrderByComparator obc)
288                    throws RemoteException {
289                    try {
290                            java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> returnValue =
291                                    DLFileEntryServiceUtil.getFileEntries(groupId, folderId, start,
292                                            end, obc);
293    
294                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModels(returnValue);
295                    }
296                    catch (Exception e) {
297                            _log.error(e, e);
298    
299                            throw new RemoteException(e.getMessage());
300                    }
301            }
302    
303            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getFileEntries(
304                    long groupId, long folderId, long fileEntryTypeId, int start, int end,
305                    com.liferay.portal.kernel.util.OrderByComparator obc)
306                    throws RemoteException {
307                    try {
308                            java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> returnValue =
309                                    DLFileEntryServiceUtil.getFileEntries(groupId, folderId,
310                                            fileEntryTypeId, start, end, obc);
311    
312                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModels(returnValue);
313                    }
314                    catch (Exception e) {
315                            _log.error(e, e);
316    
317                            throw new RemoteException(e.getMessage());
318                    }
319            }
320    
321            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getFileEntries(
322                    long groupId, long folderId, java.lang.String[] mimeTypes, int start,
323                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
324                    throws RemoteException {
325                    try {
326                            java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> returnValue =
327                                    DLFileEntryServiceUtil.getFileEntries(groupId, folderId,
328                                            mimeTypes, start, end, obc);
329    
330                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModels(returnValue);
331                    }
332                    catch (Exception e) {
333                            _log.error(e, e);
334    
335                            throw new RemoteException(e.getMessage());
336                    }
337            }
338    
339            public static int getFileEntriesCount(long groupId, long folderId)
340                    throws RemoteException {
341                    try {
342                            int returnValue = DLFileEntryServiceUtil.getFileEntriesCount(groupId,
343                                            folderId);
344    
345                            return returnValue;
346                    }
347                    catch (Exception e) {
348                            _log.error(e, e);
349    
350                            throw new RemoteException(e.getMessage());
351                    }
352            }
353    
354            public static int getFileEntriesCount(long groupId, long folderId,
355                    int status) throws RemoteException {
356                    try {
357                            int returnValue = DLFileEntryServiceUtil.getFileEntriesCount(groupId,
358                                            folderId, status);
359    
360                            return returnValue;
361                    }
362                    catch (Exception e) {
363                            _log.error(e, e);
364    
365                            throw new RemoteException(e.getMessage());
366                    }
367            }
368    
369            public static int getFileEntriesCount(long groupId, long folderId,
370                    long fileEntryTypeId) throws RemoteException {
371                    try {
372                            int returnValue = DLFileEntryServiceUtil.getFileEntriesCount(groupId,
373                                            folderId, fileEntryTypeId);
374    
375                            return returnValue;
376                    }
377                    catch (Exception e) {
378                            _log.error(e, e);
379    
380                            throw new RemoteException(e.getMessage());
381                    }
382            }
383    
384            public static int getFileEntriesCount(long groupId, long folderId,
385                    java.lang.String[] mimeTypes) throws RemoteException {
386                    try {
387                            int returnValue = DLFileEntryServiceUtil.getFileEntriesCount(groupId,
388                                            folderId, mimeTypes);
389    
390                            return returnValue;
391                    }
392                    catch (Exception e) {
393                            _log.error(e, e);
394    
395                            throw new RemoteException(e.getMessage());
396                    }
397            }
398    
399            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap getFileEntry(
400                    long fileEntryId) throws RemoteException {
401                    try {
402                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.getFileEntry(fileEntryId);
403    
404                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
405                    }
406                    catch (Exception e) {
407                            _log.error(e, e);
408    
409                            throw new RemoteException(e.getMessage());
410                    }
411            }
412    
413            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap getFileEntry(
414                    long groupId, long folderId, java.lang.String title)
415                    throws RemoteException {
416                    try {
417                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.getFileEntry(groupId,
418                                            folderId, title);
419    
420                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
421                    }
422                    catch (Exception e) {
423                            _log.error(e, e);
424    
425                            throw new RemoteException(e.getMessage());
426                    }
427            }
428    
429            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap getFileEntryByUuidAndGroupId(
430                    java.lang.String uuid, long groupId) throws RemoteException {
431                    try {
432                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.getFileEntryByUuidAndGroupId(uuid,
433                                            groupId);
434    
435                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(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 getFoldersFileEntriesCount(long groupId,
445                    Long[] folderIds, int status) throws RemoteException {
446                    try {
447                            int returnValue = DLFileEntryServiceUtil.getFoldersFileEntriesCount(groupId,
448                                            ListUtil.toList(folderIds), status);
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 com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getGroupFileEntries(
460                    long groupId, long userId, long rootFolderId, int start, int end,
461                    com.liferay.portal.kernel.util.OrderByComparator obc)
462                    throws RemoteException {
463                    try {
464                            java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> returnValue =
465                                    DLFileEntryServiceUtil.getGroupFileEntries(groupId, userId,
466                                            rootFolderId, start, end, obc);
467    
468                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModels(returnValue);
469                    }
470                    catch (Exception e) {
471                            _log.error(e, e);
472    
473                            throw new RemoteException(e.getMessage());
474                    }
475            }
476    
477            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getGroupFileEntries(
478                    long groupId, long userId, long rootFolderId,
479                    java.lang.String[] mimeTypes, int status, int start, int end,
480                    com.liferay.portal.kernel.util.OrderByComparator obc)
481                    throws RemoteException {
482                    try {
483                            java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> returnValue =
484                                    DLFileEntryServiceUtil.getGroupFileEntries(groupId, userId,
485                                            rootFolderId, mimeTypes, status, start, end, obc);
486    
487                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModels(returnValue);
488                    }
489                    catch (Exception e) {
490                            _log.error(e, e);
491    
492                            throw new RemoteException(e.getMessage());
493                    }
494            }
495    
496            public static int getGroupFileEntriesCount(long groupId, long userId,
497                    long rootFolderId) throws RemoteException {
498                    try {
499                            int returnValue = DLFileEntryServiceUtil.getGroupFileEntriesCount(groupId,
500                                            userId, rootFolderId);
501    
502                            return returnValue;
503                    }
504                    catch (Exception e) {
505                            _log.error(e, e);
506    
507                            throw new RemoteException(e.getMessage());
508                    }
509            }
510    
511            public static int getGroupFileEntriesCount(long groupId, long userId,
512                    long rootFolderId, java.lang.String[] mimeTypes, int status)
513                    throws RemoteException {
514                    try {
515                            int returnValue = DLFileEntryServiceUtil.getGroupFileEntriesCount(groupId,
516                                            userId, rootFolderId, mimeTypes, status);
517    
518                            return returnValue;
519                    }
520                    catch (Exception e) {
521                            _log.error(e, e);
522    
523                            throw new RemoteException(e.getMessage());
524                    }
525            }
526    
527            public static boolean hasFileEntryLock(long fileEntryId)
528                    throws RemoteException {
529                    try {
530                            boolean returnValue = DLFileEntryServiceUtil.hasFileEntryLock(fileEntryId);
531    
532                            return returnValue;
533                    }
534                    catch (Exception e) {
535                            _log.error(e, e);
536    
537                            throw new RemoteException(e.getMessage());
538                    }
539            }
540    
541            public static boolean isFileEntryCheckedOut(long fileEntryId)
542                    throws RemoteException {
543                    try {
544                            boolean returnValue = DLFileEntryServiceUtil.isFileEntryCheckedOut(fileEntryId);
545    
546                            return returnValue;
547                    }
548                    catch (Exception e) {
549                            _log.error(e, e);
550    
551                            throw new RemoteException(e.getMessage());
552                    }
553            }
554    
555            public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap moveFileEntry(
556                    long fileEntryId, long newFolderId,
557                    com.liferay.portal.service.ServiceContext serviceContext)
558                    throws RemoteException {
559                    try {
560                            com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.moveFileEntry(fileEntryId,
561                                            newFolderId, serviceContext);
562    
563                            return com.liferay.portlet.documentlibrary.model.DLFileEntrySoap.toSoapModel(returnValue);
564                    }
565                    catch (Exception e) {
566                            _log.error(e, e);
567    
568                            throw new RemoteException(e.getMessage());
569                    }
570            }
571    
572            public static void revertFileEntry(long fileEntryId,
573                    java.lang.String version,
574                    com.liferay.portal.service.ServiceContext serviceContext)
575                    throws RemoteException {
576                    try {
577                            DLFileEntryServiceUtil.revertFileEntry(fileEntryId, version,
578                                    serviceContext);
579                    }
580                    catch (Exception e) {
581                            _log.error(e, e);
582    
583                            throw new RemoteException(e.getMessage());
584                    }
585            }
586    
587            public static boolean verifyFileEntryCheckOut(long fileEntryId,
588                    java.lang.String lockUuid) throws RemoteException {
589                    try {
590                            boolean returnValue = DLFileEntryServiceUtil.verifyFileEntryCheckOut(fileEntryId,
591                                            lockUuid);
592    
593                            return returnValue;
594                    }
595                    catch (Exception e) {
596                            _log.error(e, e);
597    
598                            throw new RemoteException(e.getMessage());
599                    }
600            }
601    
602            public static boolean verifyFileEntryLock(long fileEntryId,
603                    java.lang.String lockUuid) throws RemoteException {
604                    try {
605                            boolean returnValue = DLFileEntryServiceUtil.verifyFileEntryLock(fileEntryId,
606                                            lockUuid);
607    
608                            return returnValue;
609                    }
610                    catch (Exception e) {
611                            _log.error(e, e);
612    
613                            throw new RemoteException(e.getMessage());
614                    }
615            }
616    
617            private static Log _log = LogFactoryUtil.getLog(DLFileEntryServiceSoap.class);
618    }