com.liferay.portlet.documentlibrary.service.http

Class DLFileEntryServiceSoap

Object

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

@ProviderType
public class DLFileEntryServiceSoap
extends Object

Provides the 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/axis. Set the property axis.servlet.hosts.allowed in portal.properties to configure security.

The SOAP utility is only generated for remote services.

Author:

Brian Wing Shun Chan

See Also:

DLFileEntryServiceHttp, DLFileEntrySoap, DLFileEntryServiceUtil

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
DLFileEntryServiceSoap()

Method Summary

Modifier and Type	Method and Description
static com.liferay.document.library.kernel.model.DLFileVersionSoap	cancelCheckOut(long fileEntryId)
static void	checkInFileEntry(long fileEntryId, boolean major, String changeLog, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static void	checkInFileEntry(long fileEntryId, String lockUuid, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static com.liferay.document.library.kernel.model.DLFileEntrySoap	checkOutFileEntry(long fileEntryId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static com.liferay.document.library.kernel.model.DLFileEntrySoap	checkOutFileEntry(long fileEntryId, String owner, long expirationTime, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static com.liferay.document.library.kernel.model.DLFileEntrySoap	copyFileEntry(long groupId, long repositoryId, long fileEntryId, long destFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static void	deleteFileEntry(long fileEntryId)
static void	deleteFileEntry(long groupId, long folderId, String title)
static void	deleteFileVersion(long fileEntryId, String version)
static com.liferay.document.library.kernel.model.DLFileEntrySoap	fetchFileEntryByImageId(long imageId)
static com.liferay.document.library.kernel.model.DLFileEntrySoap[]	getFileEntries(long groupId, long folderId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> obc)
static com.liferay.document.library.kernel.model.DLFileEntrySoap[]	getFileEntries(long groupId, long folderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> obc)
static com.liferay.document.library.kernel.model.DLFileEntrySoap[]	getFileEntries(long groupId, long folderId, long fileEntryTypeId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> obc)
static com.liferay.document.library.kernel.model.DLFileEntrySoap[]	getFileEntries(long groupId, long folderId, String[] mimeTypes, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> obc)
static int	getFileEntriesCount(long groupId, long folderId)
static int	getFileEntriesCount(long groupId, long folderId, int status)
static int	getFileEntriesCount(long groupId, long folderId, long fileEntryTypeId)
static int	getFileEntriesCount(long groupId, long folderId, String[] mimeTypes)
static com.liferay.document.library.kernel.model.DLFileEntrySoap	getFileEntry(long fileEntryId)
static com.liferay.document.library.kernel.model.DLFileEntrySoap	getFileEntry(long groupId, long folderId, String title)
static com.liferay.document.library.kernel.model.DLFileEntrySoap	getFileEntryByUuidAndGroupId(String uuid, long groupId)
static com.liferay.portal.kernel.lock.Lock	getFileEntryLock(long fileEntryId)
static int	getFoldersFileEntriesCount(long groupId, Long[] folderIds, int status)
static com.liferay.document.library.kernel.model.DLFileEntrySoap[]	getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> obc)
static com.liferay.document.library.kernel.model.DLFileEntrySoap[]	getGroupFileEntries(long groupId, long userId, long repositoryId, long rootFolderId, String[] mimeTypes, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> obc)
static com.liferay.document.library.kernel.model.DLFileEntrySoap[]	getGroupFileEntries(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> obc)
static int	getGroupFileEntriesCount(long groupId, long userId, long rootFolderId)
static int	getGroupFileEntriesCount(long groupId, long userId, long repositoryId, long rootFolderId, String[] mimeTypes, int status)
static int	getGroupFileEntriesCount(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status)
static boolean	hasFileEntryLock(long fileEntryId)
static boolean	isFileEntryCheckedOut(long fileEntryId)
static boolean	isKeepFileVersionLabel(long fileEntryId, boolean majorVersion, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static boolean	isKeepFileVersionLabel(long fileEntryId, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deprecated. As of 7.0.0, replaced by isKeepFileVersionLabel(long, boolean, ServiceContext)
static com.liferay.document.library.kernel.model.DLFileEntrySoap	moveFileEntry(long fileEntryId, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static com.liferay.portal.kernel.lock.Lock	refreshFileEntryLock(String lockUuid, long companyId, long expirationTime)
static void	revertFileEntry(long fileEntryId, String version, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static boolean	verifyFileEntryCheckOut(long fileEntryId, String lockUuid)
static boolean	verifyFileEntryLock(long fileEntryId, String lockUuid)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DLFileEntryServiceSoap

public DLFileEntryServiceSoap()

Method Detail

cancelCheckOut

public static com.liferay.document.library.kernel.model.DLFileVersionSoap cancelCheckOut(long fileEntryId)
                                                                                  throws RemoteException

Throws:

RemoteException

checkInFileEntry

public static void checkInFileEntry(long fileEntryId,
                                    boolean major,
                                    String changeLog,
                                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
                             throws RemoteException

Throws:

RemoteException

checkInFileEntry

public static void checkInFileEntry(long fileEntryId,
                                    String lockUuid,
                                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
                             throws RemoteException

Throws:

RemoteException

checkOutFileEntry

public static com.liferay.document.library.kernel.model.DLFileEntrySoap checkOutFileEntry(long fileEntryId,
                                                                                          com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                                   throws RemoteException

Throws:

RemoteException

checkOutFileEntry

public static com.liferay.document.library.kernel.model.DLFileEntrySoap checkOutFileEntry(long fileEntryId,
                                                                                          String owner,
                                                                                          long expirationTime,
                                                                                          com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                                   throws RemoteException

Throws:

RemoteException

copyFileEntry

public static com.liferay.document.library.kernel.model.DLFileEntrySoap copyFileEntry(long groupId,
                                                                                      long repositoryId,
                                                                                      long fileEntryId,
                                                                                      long destFolderId,
                                                                                      com.liferay.portal.kernel.service.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 com.liferay.document.library.kernel.model.DLFileEntrySoap fetchFileEntryByImageId(long imageId)
                                                                                         throws RemoteException

Throws:

RemoteException

getFileEntries

public static com.liferay.document.library.kernel.model.DLFileEntrySoap[] getFileEntries(long groupId,
                                                                                         long folderId,
                                                                                         int status,
                                                                                         int start,
                                                                                         int end,
                                                                                         com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> obc)
                                                                                  throws RemoteException

Throws:

RemoteException

getFileEntries

public static com.liferay.document.library.kernel.model.DLFileEntrySoap[] getFileEntries(long groupId,
                                                                                         long folderId,
                                                                                         int start,
                                                                                         int end,
                                                                                         com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> obc)
                                                                                  throws RemoteException

Throws:

RemoteException

getFileEntries

public static com.liferay.document.library.kernel.model.DLFileEntrySoap[] getFileEntries(long groupId,
                                                                                         long folderId,
                                                                                         long fileEntryTypeId,
                                                                                         int start,
                                                                                         int end,
                                                                                         com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> obc)
                                                                                  throws RemoteException

Throws:

RemoteException

getFileEntries

public static com.liferay.document.library.kernel.model.DLFileEntrySoap[] getFileEntries(long groupId,
                                                                                         long folderId,
                                                                                         String[] mimeTypes,
                                                                                         int start,
                                                                                         int end,
                                                                                         com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> 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,
                                      int status)
                               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 com.liferay.document.library.kernel.model.DLFileEntrySoap getFileEntry(long fileEntryId)
                                                                              throws RemoteException

Throws:

RemoteException

getFileEntry

public static com.liferay.document.library.kernel.model.DLFileEntrySoap getFileEntry(long groupId,
                                                                                     long folderId,
                                                                                     String title)
                                                                              throws RemoteException

Throws:

RemoteException

getFileEntryByUuidAndGroupId

public static com.liferay.document.library.kernel.model.DLFileEntrySoap getFileEntryByUuidAndGroupId(String uuid,
                                                                                                     long groupId)
                                                                                              throws RemoteException

Throws:

RemoteException

getFileEntryLock

public static com.liferay.portal.kernel.lock.Lock getFileEntryLock(long fileEntryId)
                                                            throws RemoteException

Throws:

RemoteException

getFoldersFileEntriesCount

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

Throws:

RemoteException

getGroupFileEntries

public static com.liferay.document.library.kernel.model.DLFileEntrySoap[] getGroupFileEntries(long groupId,
                                                                                              long userId,
                                                                                              long rootFolderId,
                                                                                              int start,
                                                                                              int end,
                                                                                              com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> obc)
                                                                                       throws RemoteException

Throws:

RemoteException

getGroupFileEntries

public static com.liferay.document.library.kernel.model.DLFileEntrySoap[] getGroupFileEntries(long groupId,
                                                                                              long userId,
                                                                                              long repositoryId,
                                                                                              long rootFolderId,
                                                                                              String[] mimeTypes,
                                                                                              int status,
                                                                                              int start,
                                                                                              int end,
                                                                                              com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> obc)
                                                                                       throws RemoteException

Throws:

RemoteException

getGroupFileEntries

public static com.liferay.document.library.kernel.model.DLFileEntrySoap[] getGroupFileEntries(long groupId,
                                                                                              long userId,
                                                                                              long rootFolderId,
                                                                                              String[] mimeTypes,
                                                                                              int status,
                                                                                              int start,
                                                                                              int end,
                                                                                              com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> 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 repositoryId,
                                           long rootFolderId,
                                           String[] mimeTypes,
                                           int status)
                                    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

isKeepFileVersionLabel

public static boolean isKeepFileVersionLabel(long fileEntryId,
                                             boolean majorVersion,
                                             com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                      throws RemoteException

Throws:

RemoteException

isKeepFileVersionLabel

@Deprecated
public static boolean isKeepFileVersionLabel(long fileEntryId,
                                                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                  throws RemoteException

Deprecated. As of 7.0.0, replaced by isKeepFileVersionLabel(long, boolean, ServiceContext)

Throws:

RemoteException

moveFileEntry

public static com.liferay.document.library.kernel.model.DLFileEntrySoap moveFileEntry(long fileEntryId,
                                                                                      long newFolderId,
                                                                                      com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                               throws RemoteException

Throws:

RemoteException

refreshFileEntryLock

public static com.liferay.portal.kernel.lock.Lock refreshFileEntryLock(String lockUuid,
                                                                       long companyId,
                                                                       long expirationTime)
                                                                throws RemoteException

Throws:

RemoteException

revertFileEntry

public static void revertFileEntry(long fileEntryId,
                                   String version,
                                   com.liferay.portal.kernel.service.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