@ProviderType
public class DLFileEntryServiceSoap
extends java.lang.Object
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.
DLFileEntryServiceHttp,
DLFileEntrySoap,
DLFileEntryServiceUtil| Constructor and Description |
|---|
DLFileEntryServiceSoap() |
| Modifier and Type | Method and Description |
|---|---|
static com.liferay.portlet.documentlibrary.model.DLFileVersionSoap |
cancelCheckOut(long fileEntryId) |
static void |
checkInFileEntry(long fileEntryId,
boolean major,
java.lang.String changeLog,
com.liferay.portal.service.ServiceContext serviceContext) |
static void |
checkInFileEntry(long fileEntryId,
java.lang.String lockUuid)
Deprecated.
As of 6.2.0, replaced by
checkInFileEntry(long,
String, ServiceContext) |
static void |
checkInFileEntry(long fileEntryId,
java.lang.String lockUuid,
com.liferay.portal.service.ServiceContext serviceContext) |
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap |
checkOutFileEntry(long fileEntryId)
Deprecated.
As of 6.2.0, replaced by
checkOutFileEntry(long,
ServiceContext) |
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap |
checkOutFileEntry(long fileEntryId,
com.liferay.portal.service.ServiceContext serviceContext) |
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap |
checkOutFileEntry(long fileEntryId,
java.lang.String owner,
long expirationTime)
Deprecated.
As of 6.2.0, replaced by
checkOutFileEntry(long,
String, long, ServiceContext) |
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap |
checkOutFileEntry(long fileEntryId,
java.lang.String owner,
long expirationTime,
com.liferay.portal.service.ServiceContext serviceContext) |
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap |
copyFileEntry(long groupId,
long repositoryId,
long fileEntryId,
long destFolderId,
com.liferay.portal.service.ServiceContext serviceContext) |
static void |
deleteFileEntry(long fileEntryId) |
static void |
deleteFileEntry(long groupId,
long folderId,
java.lang.String title) |
static void |
deleteFileVersion(long fileEntryId,
java.lang.String version) |
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap |
fetchFileEntryByImageId(long imageId) |
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] |
getFileEntries(long groupId,
long folderId,
int status,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc) |
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] |
getFileEntries(long groupId,
long folderId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc) |
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] |
getFileEntries(long groupId,
long folderId,
long fileEntryTypeId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc) |
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] |
getFileEntries(long groupId,
long folderId,
java.lang.String[] mimeTypes,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.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,
java.lang.String[] mimeTypes) |
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap |
getFileEntry(long fileEntryId) |
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap |
getFileEntry(long groupId,
long folderId,
java.lang.String title) |
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap |
getFileEntryByUuidAndGroupId(java.lang.String uuid,
long groupId) |
static com.liferay.portal.kernel.lock.Lock |
getFileEntryLock(long fileEntryId) |
static int |
getFoldersFileEntriesCount(long groupId,
java.lang.Long[] folderIds,
int status) |
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] |
getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc) |
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] |
getGroupFileEntries(long groupId,
long userId,
long repositoryId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc) |
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] |
getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc) |
static int |
getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId) |
static int |
getGroupFileEntriesCount(long groupId,
long userId,
long repositoryId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status) |
static int |
getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status) |
static boolean |
hasFileEntryLock(long fileEntryId) |
static boolean |
isFileEntryCheckedOut(long fileEntryId) |
static boolean |
isKeepFileVersionLabel(long fileEntryId,
com.liferay.portal.service.ServiceContext serviceContext) |
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap |
moveFileEntry(long fileEntryId,
long newFolderId,
com.liferay.portal.service.ServiceContext serviceContext) |
static com.liferay.portal.kernel.lock.Lock |
refreshFileEntryLock(java.lang.String lockUuid,
long companyId,
long expirationTime) |
static void |
revertFileEntry(long fileEntryId,
java.lang.String version,
com.liferay.portal.service.ServiceContext serviceContext) |
static boolean |
verifyFileEntryCheckOut(long fileEntryId,
java.lang.String lockUuid) |
static boolean |
verifyFileEntryLock(long fileEntryId,
java.lang.String lockUuid) |
public static com.liferay.portlet.documentlibrary.model.DLFileVersionSoap cancelCheckOut(long fileEntryId)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static void checkInFileEntry(long fileEntryId,
boolean major,
java.lang.String changeLog,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
java.rmi.RemoteException@Deprecated
public static void checkInFileEntry(long fileEntryId,
java.lang.String lockUuid)
throws java.rmi.RemoteException
checkInFileEntry(long,
String, ServiceContext)java.rmi.RemoteExceptionpublic static void checkInFileEntry(long fileEntryId,
java.lang.String lockUuid,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
java.rmi.RemoteException@Deprecated
public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap checkOutFileEntry(long fileEntryId)
throws java.rmi.RemoteException
checkOutFileEntry(long,
ServiceContext)java.rmi.RemoteExceptionpublic static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap checkOutFileEntry(long fileEntryId,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
java.rmi.RemoteException@Deprecated
public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap checkOutFileEntry(long fileEntryId,
java.lang.String owner,
long expirationTime)
throws java.rmi.RemoteException
checkOutFileEntry(long,
String, long, ServiceContext)java.rmi.RemoteExceptionpublic static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap checkOutFileEntry(long fileEntryId,
java.lang.String owner,
long expirationTime,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap copyFileEntry(long groupId,
long repositoryId,
long fileEntryId,
long destFolderId,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static void deleteFileEntry(long fileEntryId)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static void deleteFileEntry(long groupId,
long folderId,
java.lang.String title)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static void deleteFileVersion(long fileEntryId,
java.lang.String version)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap fetchFileEntryByImageId(long imageId)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getFileEntries(long groupId,
long folderId,
int status,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getFileEntries(long groupId,
long folderId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getFileEntries(long groupId,
long folderId,
long fileEntryTypeId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getFileEntries(long groupId,
long folderId,
java.lang.String[] mimeTypes,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static int getFileEntriesCount(long groupId,
long folderId)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static int getFileEntriesCount(long groupId,
long folderId,
int status)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static int getFileEntriesCount(long groupId,
long folderId,
long fileEntryTypeId)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static int getFileEntriesCount(long groupId,
long folderId,
java.lang.String[] mimeTypes)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap getFileEntry(long fileEntryId)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap getFileEntry(long groupId,
long folderId,
java.lang.String title)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap getFileEntryByUuidAndGroupId(java.lang.String uuid,
long groupId)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portal.kernel.lock.Lock getFileEntryLock(long fileEntryId)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static int getFoldersFileEntriesCount(long groupId,
java.lang.Long[] folderIds,
int status)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getGroupFileEntries(long groupId,
long userId,
long repositoryId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static int getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static int getGroupFileEntriesCount(long groupId,
long userId,
long repositoryId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static int getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static boolean hasFileEntryLock(long fileEntryId)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static boolean isFileEntryCheckedOut(long fileEntryId)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static boolean isKeepFileVersionLabel(long fileEntryId,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap moveFileEntry(long fileEntryId,
long newFolderId,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portal.kernel.lock.Lock refreshFileEntryLock(java.lang.String lockUuid,
long companyId,
long expirationTime)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static void revertFileEntry(long fileEntryId,
java.lang.String version,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static boolean verifyFileEntryCheckOut(long fileEntryId,
java.lang.String lockUuid)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static boolean verifyFileEntryLock(long fileEntryId,
java.lang.String lockUuid)
throws java.rmi.RemoteException
java.rmi.RemoteException