public class DLFileEntryServiceSoap
extends Object
DLFileEntryServiceUtil
service
utility. The static methods of this class call 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 java.util.List
,
that is translated to an array of
com.liferay.document.library.kernel.model.DLFileEntrySoap
. If the method in the
service utility returns a
com.liferay.document.library.kernel.model.DLFileEntry
, that is translated to a
com.liferay.document.library.kernel.model.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
Constructor and Description |
---|
DLFileEntryServiceSoap() |
Modifier and Type | Method and Description |
---|---|
static com.liferay.document.library.kernel.model.DLFileVersionSoap |
cancelCheckOut(long fileEntryId) |
static void |
checkInFileEntry(long fileEntryId,
com.liferay.document.library.kernel.model.DLVersionNumberIncrease dlVersionNumberIncrease,
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> orderByComparator) |
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> orderByComparator) |
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> orderByComparator) |
static com.liferay.document.library.kernel.model.DLFileEntrySoap[] |
getFileEntries(long groupId,
long folderId,
String[] mimeTypes,
int status,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> orderByComparator) |
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> orderByComparator) |
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 int |
getFileEntriesCount(long groupId,
long folderId,
String[] mimeTypes,
int status) |
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> orderByComparator) |
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> orderByComparator) |
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> orderByComparator) |
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 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) |
public static com.liferay.document.library.kernel.model.DLFileVersionSoap cancelCheckOut(long fileEntryId) throws RemoteException
RemoteException
public static void checkInFileEntry(long fileEntryId, com.liferay.document.library.kernel.model.DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws RemoteException
RemoteException
public static void checkInFileEntry(long fileEntryId, String lockUuid, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws RemoteException
RemoteException
public static com.liferay.document.library.kernel.model.DLFileEntrySoap checkOutFileEntry(long fileEntryId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws RemoteException
RemoteException
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
RemoteException
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
RemoteException
public static void deleteFileEntry(long fileEntryId) throws RemoteException
RemoteException
public static void deleteFileEntry(long groupId, long folderId, String title) throws RemoteException
RemoteException
public static void deleteFileVersion(long fileEntryId, String version) throws RemoteException
RemoteException
public static com.liferay.document.library.kernel.model.DLFileEntrySoap fetchFileEntryByImageId(long imageId) throws RemoteException
RemoteException
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> orderByComparator) throws RemoteException
RemoteException
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> orderByComparator) throws RemoteException
RemoteException
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> orderByComparator) throws RemoteException
RemoteException
public static com.liferay.document.library.kernel.model.DLFileEntrySoap[] getFileEntries(long groupId, long folderId, String[] mimeTypes, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> orderByComparator) throws RemoteException
RemoteException
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> orderByComparator) throws RemoteException
RemoteException
public static int getFileEntriesCount(long groupId, long folderId) throws RemoteException
RemoteException
public static int getFileEntriesCount(long groupId, long folderId, int status) throws RemoteException
RemoteException
public static int getFileEntriesCount(long groupId, long folderId, long fileEntryTypeId) throws RemoteException
RemoteException
public static int getFileEntriesCount(long groupId, long folderId, String[] mimeTypes) throws RemoteException
RemoteException
public static int getFileEntriesCount(long groupId, long folderId, String[] mimeTypes, int status) throws RemoteException
RemoteException
public static com.liferay.document.library.kernel.model.DLFileEntrySoap getFileEntry(long fileEntryId) throws RemoteException
RemoteException
public static com.liferay.document.library.kernel.model.DLFileEntrySoap getFileEntry(long groupId, long folderId, String title) throws RemoteException
RemoteException
public static com.liferay.document.library.kernel.model.DLFileEntrySoap getFileEntryByUuidAndGroupId(String uuid, long groupId) throws RemoteException
RemoteException
public static com.liferay.portal.kernel.lock.Lock getFileEntryLock(long fileEntryId) throws RemoteException
RemoteException
public static int getFoldersFileEntriesCount(long groupId, Long[] folderIds, int status) throws RemoteException
RemoteException
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> orderByComparator) throws RemoteException
RemoteException
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> orderByComparator) throws RemoteException
RemoteException
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> orderByComparator) throws RemoteException
RemoteException
public static int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId) throws RemoteException
RemoteException
public static int getGroupFileEntriesCount(long groupId, long userId, long repositoryId, long rootFolderId, String[] mimeTypes, int status) throws RemoteException
RemoteException
public static int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status) throws RemoteException
RemoteException
public static boolean hasFileEntryLock(long fileEntryId) throws RemoteException
RemoteException
public static boolean isFileEntryCheckedOut(long fileEntryId) throws RemoteException
RemoteException
public static com.liferay.document.library.kernel.model.DLFileEntrySoap moveFileEntry(long fileEntryId, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws RemoteException
RemoteException
public static com.liferay.portal.kernel.lock.Lock refreshFileEntryLock(String lockUuid, long companyId, long expirationTime) throws RemoteException
RemoteException
public static void revertFileEntry(long fileEntryId, String version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws RemoteException
RemoteException
public static boolean verifyFileEntryCheckOut(long fileEntryId, String lockUuid) throws RemoteException
RemoteException
public static boolean verifyFileEntryLock(long fileEntryId, String lockUuid) throws RemoteException
RemoteException