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