Liferay 6.1.2-ce-ga3

com.liferay.portlet.documentlibrary.service.http
Class DLFileEntryServiceSoap

java.lang.Object
  extended by com.liferay.portlet.documentlibrary.service.http.DLFileEntryServiceSoap

public class DLFileEntryServiceSoap
extends Object

This class provides a SOAP utility for the DLFileEntryServiceUtil service utility. The static methods of this class calls the same methods of the service utility. However, the signatures are different because it is difficult for SOAP to support certain types.

ServiceBuilder follows certain rules in translating the methods. For example, if the method in the service utility returns a List, that is translated to an array of DLFileEntrySoap. If the method in the service utility returns a DLFileEntry, that is translated to a DLFileEntrySoap. Methods that SOAP cannot safely wire are skipped.

The benefits of using the SOAP utility is that it is cross platform compatible. SOAP allows different languages like Java, .NET, C++, PHP, and even Perl, to call the generated services. One drawback of SOAP is that it is slow because it needs to serialize all calls into a text format (XML).

You can see a list of services at http://localhost:8080/api/secure/axis. Set the property axis.servlet.hosts.allowed in portal.properties to configure security.

The SOAP utility is only generated for remote services.

See Also:
DLFileEntryServiceHttp, DLFileEntrySoap, DLFileEntryServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
DLFileEntryServiceSoap()
           
 
Method Summary
static DLFileVersionSoap cancelCheckOut(long fileEntryId)
           
static void checkInFileEntry(long fileEntryId, boolean major, String changeLog, ServiceContext serviceContext)
           
static void checkInFileEntry(long fileEntryId, String lockUuid)
           
static DLFileEntrySoap checkOutFileEntry(long fileEntryId)
          Deprecated. checkOutFileEntry(long, ServiceContext)
static DLFileEntrySoap checkOutFileEntry(long fileEntryId, ServiceContext serviceContext)
           
static DLFileEntrySoap checkOutFileEntry(long fileEntryId, String owner, long expirationTime)
          Deprecated. checkOutFileEntry(long, String, long, ServiceContext)
static DLFileEntrySoap checkOutFileEntry(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext)
           
static DLFileEntrySoap copyFileEntry(long groupId, long repositoryId, long fileEntryId, long destFolderId, ServiceContext serviceContext)
           
static void deleteFileEntry(long fileEntryId)
           
static void deleteFileEntry(long groupId, long folderId, String title)
           
static void deleteFileVersion(long fileEntryId, String version)
           
static DLFileEntrySoap fetchFileEntryByImageId(long imageId)
           
static DLFileEntrySoap[] getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator obc)
           
static DLFileEntrySoap[] getFileEntries(long groupId, long folderId, long fileEntryTypeId, int start, int end, OrderByComparator obc)
           
static DLFileEntrySoap[] getFileEntries(long groupId, long folderId, String[] mimeTypes, int start, int end, OrderByComparator obc)
           
static int getFileEntriesCount(long groupId, long folderId)
           
static int getFileEntriesCount(long groupId, long folderId, long fileEntryTypeId)
           
static int getFileEntriesCount(long groupId, long folderId, String[] mimeTypes)
           
static DLFileEntrySoap getFileEntry(long fileEntryId)
           
static DLFileEntrySoap getFileEntry(long groupId, long folderId, String title)
           
static DLFileEntrySoap getFileEntryByUuidAndGroupId(String uuid, long groupId)
           
static int getFoldersFileEntriesCount(long groupId, Long[] folderIds, int status)
           
static DLFileEntrySoap[] getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator obc)
           
static DLFileEntrySoap[] getGroupFileEntries(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator obc)
           
static int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId)
           
static int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status)
           
static boolean hasFileEntryLock(long fileEntryId)
           
static boolean isFileEntryCheckedOut(long fileEntryId)
           
static DLFileEntrySoap moveFileEntry(long fileEntryId, long newFolderId, ServiceContext serviceContext)
           
static void revertFileEntry(long fileEntryId, String version, ServiceContext serviceContext)
           
static boolean verifyFileEntryCheckOut(long fileEntryId, String lockUuid)
           
static boolean verifyFileEntryLock(long fileEntryId, String lockUuid)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DLFileEntryServiceSoap

public DLFileEntryServiceSoap()
Method Detail

cancelCheckOut

public static DLFileVersionSoap cancelCheckOut(long fileEntryId)
                                        throws RemoteException
Throws:
RemoteException

checkInFileEntry

public static void checkInFileEntry(long fileEntryId,
                                    boolean major,
                                    String changeLog,
                                    ServiceContext serviceContext)
                             throws RemoteException
Throws:
RemoteException

checkInFileEntry

public static void checkInFileEntry(long fileEntryId,
                                    String lockUuid)
                             throws RemoteException
Throws:
RemoteException

checkOutFileEntry

public static DLFileEntrySoap checkOutFileEntry(long fileEntryId)
                                         throws RemoteException
Deprecated. checkOutFileEntry(long, ServiceContext)

Throws:
RemoteException

checkOutFileEntry

public static DLFileEntrySoap checkOutFileEntry(long fileEntryId,
                                                ServiceContext serviceContext)
                                         throws RemoteException
Throws:
RemoteException

checkOutFileEntry

public static DLFileEntrySoap checkOutFileEntry(long fileEntryId,
                                                String owner,
                                                long expirationTime)
                                         throws RemoteException
Deprecated. checkOutFileEntry(long, String, long, ServiceContext)

Throws:
RemoteException

checkOutFileEntry

public static DLFileEntrySoap checkOutFileEntry(long fileEntryId,
                                                String owner,
                                                long expirationTime,
                                                ServiceContext serviceContext)
                                         throws RemoteException
Throws:
RemoteException

copyFileEntry

public static DLFileEntrySoap copyFileEntry(long groupId,
                                            long repositoryId,
                                            long fileEntryId,
                                            long destFolderId,
                                            ServiceContext serviceContext)
                                     throws RemoteException
Throws:
RemoteException

deleteFileEntry

public static void deleteFileEntry(long fileEntryId)
                            throws RemoteException
Throws:
RemoteException

deleteFileEntry

public static void deleteFileEntry(long groupId,
                                   long folderId,
                                   String title)
                            throws RemoteException
Throws:
RemoteException

deleteFileVersion

public static void deleteFileVersion(long fileEntryId,
                                     String version)
                              throws RemoteException
Throws:
RemoteException

fetchFileEntryByImageId

public static DLFileEntrySoap fetchFileEntryByImageId(long imageId)
                                               throws RemoteException
Throws:
RemoteException

getFileEntries

public static DLFileEntrySoap[] getFileEntries(long groupId,
                                               long folderId,
                                               int start,
                                               int end,
                                               OrderByComparator obc)
                                        throws RemoteException
Throws:
RemoteException

getFileEntries

public static DLFileEntrySoap[] getFileEntries(long groupId,
                                               long folderId,
                                               long fileEntryTypeId,
                                               int start,
                                               int end,
                                               OrderByComparator obc)
                                        throws RemoteException
Throws:
RemoteException

getFileEntries

public static DLFileEntrySoap[] getFileEntries(long groupId,
                                               long folderId,
                                               String[] mimeTypes,
                                               int start,
                                               int end,
                                               OrderByComparator obc)
                                        throws RemoteException
Throws:
RemoteException

getFileEntriesCount

public static int getFileEntriesCount(long groupId,
                                      long folderId)
                               throws RemoteException
Throws:
RemoteException

getFileEntriesCount

public static int getFileEntriesCount(long groupId,
                                      long folderId,
                                      long fileEntryTypeId)
                               throws RemoteException
Throws:
RemoteException

getFileEntriesCount

public static int getFileEntriesCount(long groupId,
                                      long folderId,
                                      String[] mimeTypes)
                               throws RemoteException
Throws:
RemoteException

getFileEntry

public static DLFileEntrySoap getFileEntry(long fileEntryId)
                                    throws RemoteException
Throws:
RemoteException

getFileEntry

public static DLFileEntrySoap getFileEntry(long groupId,
                                           long folderId,
                                           String title)
                                    throws RemoteException
Throws:
RemoteException

getFileEntryByUuidAndGroupId

public static DLFileEntrySoap getFileEntryByUuidAndGroupId(String uuid,
                                                           long groupId)
                                                    throws RemoteException
Throws:
RemoteException

getFoldersFileEntriesCount

public static int getFoldersFileEntriesCount(long groupId,
                                             Long[] folderIds,
                                             int status)
                                      throws RemoteException
Throws:
RemoteException

getGroupFileEntries

public static DLFileEntrySoap[] getGroupFileEntries(long groupId,
                                                    long userId,
                                                    long rootFolderId,
                                                    int start,
                                                    int end,
                                                    OrderByComparator obc)
                                             throws RemoteException
Throws:
RemoteException

getGroupFileEntries

public static DLFileEntrySoap[] getGroupFileEntries(long groupId,
                                                    long userId,
                                                    long rootFolderId,
                                                    String[] mimeTypes,
                                                    int status,
                                                    int start,
                                                    int end,
                                                    OrderByComparator obc)
                                             throws RemoteException
Throws:
RemoteException

getGroupFileEntriesCount

public static int getGroupFileEntriesCount(long groupId,
                                           long userId,
                                           long rootFolderId)
                                    throws RemoteException
Throws:
RemoteException

getGroupFileEntriesCount

public static int getGroupFileEntriesCount(long groupId,
                                           long userId,
                                           long rootFolderId,
                                           String[] mimeTypes,
                                           int status)
                                    throws RemoteException
Throws:
RemoteException

hasFileEntryLock

public static boolean hasFileEntryLock(long fileEntryId)
                                throws RemoteException
Throws:
RemoteException

isFileEntryCheckedOut

public static boolean isFileEntryCheckedOut(long fileEntryId)
                                     throws RemoteException
Throws:
RemoteException

moveFileEntry

public static DLFileEntrySoap moveFileEntry(long fileEntryId,
                                            long newFolderId,
                                            ServiceContext serviceContext)
                                     throws RemoteException
Throws:
RemoteException

revertFileEntry

public static void revertFileEntry(long fileEntryId,
                                   String version,
                                   ServiceContext serviceContext)
                            throws RemoteException
Throws:
RemoteException

verifyFileEntryCheckOut

public static boolean verifyFileEntryCheckOut(long fileEntryId,
                                              String lockUuid)
                                       throws RemoteException
Throws:
RemoteException

verifyFileEntryLock

public static boolean verifyFileEntryLock(long fileEntryId,
                                          String lockUuid)
                                   throws RemoteException
Throws:
RemoteException

Liferay 6.1.2-ce-ga3