com.liferay.portlet.documentlibrary.service.http
Class DLFolderServiceSoap
java.lang.Object
com.liferay.portlet.documentlibrary.service.http.DLFolderServiceSoap
public class DLFolderServiceSoap
- extends Object
This class provides a SOAP utility for the
DLFolderServiceUtil
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 DLFolderSoap
.
If the method in the service utility returns a
DLFolder
, that is translated to a
DLFolderSoap
. 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:
DLFolderServiceHttp
,
DLFolderSoap
,
DLFolderServiceUtil
- ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.
Method Summary |
static DLFolderSoap |
addFolder(long groupId,
long repositoryId,
boolean mountPoint,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
|
static void |
deleteFolder(long folderId)
|
static void |
deleteFolder(long groupId,
long parentFolderId,
String name)
|
static int |
getFileEntriesAndFileShortcutsCount(long groupId,
long folderId,
int status)
|
static int |
getFileEntriesAndFileShortcutsCount(long groupId,
long folderId,
int status,
String[] mimeTypes)
|
static DLFolderSoap |
getFolder(long folderId)
|
static DLFolderSoap |
getFolder(long groupId,
long parentFolderId,
String name)
|
static long[] |
getFolderIds(long groupId,
long folderId)
|
static DLFolderSoap[] |
getFolders(long groupId,
long parentFolderId,
boolean includeMountfolders,
int start,
int end,
OrderByComparator obc)
|
static DLFolderSoap[] |
getFolders(long groupId,
long parentFolderId,
int start,
int end,
OrderByComparator obc)
|
static int |
getFoldersAndFileEntriesAndFileShortcuts(long groupId,
long folderId,
int status,
String[] mimeTypes,
boolean includeMountFolders)
|
static int |
getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
long folderId,
int status,
boolean includeMountFolders)
|
static int |
getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
long folderId,
int status,
String[] mimeTypes,
boolean includeMountFolders)
|
static int |
getFoldersCount(long groupId,
long parentFolderId)
|
static int |
getFoldersCount(long groupId,
long parentFolderId,
boolean includeMountfolders)
|
static DLFolderSoap[] |
getMountFolders(long groupId,
long parentFolderId,
int start,
int end,
OrderByComparator obc)
|
static int |
getMountFoldersCount(long groupId,
long parentFolderId)
|
static void |
getSubfolderIds(Long[] folderIds,
long groupId,
long folderId)
|
static Long[] |
getSubfolderIds(long groupId,
long folderId,
boolean recurse)
|
static boolean |
hasFolderLock(long folderId)
|
static boolean |
hasInheritableLock(long folderId)
|
static boolean |
isFolderLocked(long folderId)
|
static DLFolderSoap |
moveFolder(long folderId,
long parentFolderId,
ServiceContext serviceContext)
|
static void |
unlockFolder(long groupId,
long folderId,
String lockUuid)
|
static void |
unlockFolder(long groupId,
long parentFolderId,
String name,
String lockUuid)
|
static DLFolderSoap |
updateFolder(long folderId,
String name,
String description,
long defaultFileEntryTypeId,
Long[] fileEntryTypeIds,
boolean overrideFileEntryTypes,
ServiceContext serviceContext)
|
static boolean |
verifyInheritableLock(long folderId,
String lockUuid)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DLFolderServiceSoap
public DLFolderServiceSoap()
addFolder
public static DLFolderSoap addFolder(long groupId,
long repositoryId,
boolean mountPoint,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
throws RemoteException
- Throws:
RemoteException
deleteFolder
public static void deleteFolder(long folderId)
throws RemoteException
- Throws:
RemoteException
deleteFolder
public static void deleteFolder(long groupId,
long parentFolderId,
String name)
throws RemoteException
- Throws:
RemoteException
getFileEntriesAndFileShortcutsCount
public static int getFileEntriesAndFileShortcutsCount(long groupId,
long folderId,
int status)
throws RemoteException
- Throws:
RemoteException
getFileEntriesAndFileShortcutsCount
public static int getFileEntriesAndFileShortcutsCount(long groupId,
long folderId,
int status,
String[] mimeTypes)
throws RemoteException
- Throws:
RemoteException
getFolder
public static DLFolderSoap getFolder(long folderId)
throws RemoteException
- Throws:
RemoteException
getFolder
public static DLFolderSoap getFolder(long groupId,
long parentFolderId,
String name)
throws RemoteException
- Throws:
RemoteException
getFolderIds
public static long[] getFolderIds(long groupId,
long folderId)
throws RemoteException
- Throws:
RemoteException
getFolders
public static DLFolderSoap[] getFolders(long groupId,
long parentFolderId,
boolean includeMountfolders,
int start,
int end,
OrderByComparator obc)
throws RemoteException
- Throws:
RemoteException
getFolders
public static DLFolderSoap[] getFolders(long groupId,
long parentFolderId,
int start,
int end,
OrderByComparator obc)
throws RemoteException
- Throws:
RemoteException
getFoldersAndFileEntriesAndFileShortcuts
public static int getFoldersAndFileEntriesAndFileShortcuts(long groupId,
long folderId,
int status,
String[] mimeTypes,
boolean includeMountFolders)
throws RemoteException
- Throws:
RemoteException
getFoldersAndFileEntriesAndFileShortcutsCount
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
long folderId,
int status,
boolean includeMountFolders)
throws RemoteException
- Throws:
RemoteException
getFoldersAndFileEntriesAndFileShortcutsCount
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
long folderId,
int status,
String[] mimeTypes,
boolean includeMountFolders)
throws RemoteException
- Throws:
RemoteException
getFoldersCount
public static int getFoldersCount(long groupId,
long parentFolderId)
throws RemoteException
- Throws:
RemoteException
getFoldersCount
public static int getFoldersCount(long groupId,
long parentFolderId,
boolean includeMountfolders)
throws RemoteException
- Throws:
RemoteException
getMountFolders
public static DLFolderSoap[] getMountFolders(long groupId,
long parentFolderId,
int start,
int end,
OrderByComparator obc)
throws RemoteException
- Throws:
RemoteException
getMountFoldersCount
public static int getMountFoldersCount(long groupId,
long parentFolderId)
throws RemoteException
- Throws:
RemoteException
getSubfolderIds
public static void getSubfolderIds(Long[] folderIds,
long groupId,
long folderId)
throws RemoteException
- Throws:
RemoteException
getSubfolderIds
public static Long[] getSubfolderIds(long groupId,
long folderId,
boolean recurse)
throws RemoteException
- Throws:
RemoteException
hasFolderLock
public static boolean hasFolderLock(long folderId)
throws RemoteException
- Throws:
RemoteException
hasInheritableLock
public static boolean hasInheritableLock(long folderId)
throws RemoteException
- Throws:
RemoteException
isFolderLocked
public static boolean isFolderLocked(long folderId)
throws RemoteException
- Throws:
RemoteException
moveFolder
public static DLFolderSoap moveFolder(long folderId,
long parentFolderId,
ServiceContext serviceContext)
throws RemoteException
- Throws:
RemoteException
unlockFolder
public static void unlockFolder(long groupId,
long folderId,
String lockUuid)
throws RemoteException
- Throws:
RemoteException
unlockFolder
public static void unlockFolder(long groupId,
long parentFolderId,
String name,
String lockUuid)
throws RemoteException
- Throws:
RemoteException
updateFolder
public static DLFolderSoap updateFolder(long folderId,
String name,
String description,
long defaultFileEntryTypeId,
Long[] fileEntryTypeIds,
boolean overrideFileEntryTypes,
ServiceContext serviceContext)
throws RemoteException
- Throws:
RemoteException
verifyInheritableLock
public static boolean verifyInheritableLock(long folderId,
String lockUuid)
throws RemoteException
- Throws:
RemoteException