com.liferay.portlet.documentlibrary.service.http

Class DLFolderServiceSoap

Object

com.liferay.portlet.documentlibrary.service.http.DLFolderServiceSoap

public class DLFolderServiceSoap
extends Object

Provides the SOAP utility for the DLFolderServiceUtil 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.DLFolderSoap. If the method in the service utility returns a com.liferay.document.library.kernel.model.DLFolder, that is translated to a com.liferay.document.library.kernel.model.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/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:

DLFolderServiceHttp

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
DLFolderServiceSoap()

Method Summary

Modifier and Type	Method and Description
static com.liferay.document.library.kernel.model.DLFolderSoap	addFolder(long groupId, long repositoryId, boolean mountPoint, long parentFolderId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static void	deleteFolder(long folderId)
static void	deleteFolder(long folderId, boolean includeTrashedEntries)
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) Deprecated. As of Athanasius (7.3.x), replaced by getFileEntriesAndFileShortcutsCount(long, long, String[], int)
static int	getFileEntriesAndFileShortcutsCount(long groupId, long folderId, String[] mimeTypes, int status)
static com.liferay.document.library.kernel.model.DLFolderSoap	getFolder(long folderId)
static com.liferay.document.library.kernel.model.DLFolderSoap	getFolder(long groupId, long parentFolderId, String name)
static Long[]	getFolderIds(long groupId, long folderId)
static com.liferay.document.library.kernel.model.DLFolderSoap[]	getFolders(long groupId, long parentFolderId, boolean includeMountfolders, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFolder> orderByComparator)
static com.liferay.document.library.kernel.model.DLFolderSoap[]	getFolders(long groupId, long parentFolderId, int status, boolean includeMountfolders, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFolder> orderByComparator) Deprecated. As of Athanasius (7.3.x), replaced by getFolders(long, long, boolean, int, int, int, OrderByComparator)
static com.liferay.document.library.kernel.model.DLFolderSoap[]	getFolders(long groupId, long parentFolderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFolder> orderByComparator)
static int	getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status, boolean includeMountFolders)
static int	getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders) Deprecated. As of Athanasius (7.3.x), replaced by getFoldersAndFileEntriesAndFileShortcutsCount(long, long, String[], boolean, int)
static int	getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, String[] mimeTypes, boolean includeMountFolders, int status)
static int	getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, String[] mimeTypes, boolean includeMountFolders, com.liferay.portal.kernel.dao.orm.QueryDefinition<?> queryDefinition)
static int	getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, String[] mimeTypes, long fileEntryTypeId, boolean includeMountFolders, int status)
static int	getFoldersCount(long groupId, long parentFolderId)
static int	getFoldersCount(long groupId, long parentFolderId, boolean includeMountfolders, int status)
static int	getFoldersCount(long groupId, long parentFolderId, int status, boolean includeMountfolders) Deprecated. As of Athanasius (7.3.x), replaced by getFoldersCount(long, long, boolean, int)
static com.liferay.document.library.kernel.model.DLFolderSoap[]	getMountFolders(long groupId, long parentFolderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFolder> orderByComparator)
static int	getMountFoldersCount(long groupId, long parentFolderId)
static void	getSubfolderIds(Long[] folderIds, long groupId, long folderId, boolean recurse)
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 com.liferay.portal.kernel.lock.Lock	lockFolder(long folderId)
static com.liferay.portal.kernel.lock.Lock	lockFolder(long folderId, String owner, boolean inheritable, long expirationTime)
static com.liferay.document.library.kernel.model.DLFolderSoap	moveFolder(long folderId, long parentFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static com.liferay.portal.kernel.lock.Lock	refreshFolderLock(String lockUuid, long companyId, long expirationTime)
static void	unlockFolder(long groupId, long parentFolderId, String name, String lockUuid)
static void	unlockFolder(long folderId, String lockUuid)
static com.liferay.document.library.kernel.model.DLFolderSoap	updateFolder(long folderId, long parentFolderId, String name, String description, long defaultFileEntryTypeId, Long[] fileEntryTypeIds, int restrictionType, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static com.liferay.document.library.kernel.model.DLFolderSoap	updateFolder(long folderId, String name, String description, long defaultFileEntryTypeId, Long[] fileEntryTypeIds, int restrictionType, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static boolean	verifyInheritableLock(long folderId, String lockUuid)

Methods inherited from class Object

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

Constructor Detail

DLFolderServiceSoap

public DLFolderServiceSoap()

Method Detail

addFolder

public static com.liferay.document.library.kernel.model.DLFolderSoap addFolder(long groupId,
                                                                               long repositoryId,
                                                                               boolean mountPoint,
                                                                               long parentFolderId,
                                                                               String name,
                                                                               String description,
                                                                               com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                        throws RemoteException

Throws:

RemoteException

deleteFolder

public static void deleteFolder(long folderId)
                         throws RemoteException

Throws:

RemoteException

deleteFolder

public static void deleteFolder(long folderId,
                                boolean includeTrashedEntries)
                         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

@Deprecated
public static int getFileEntriesAndFileShortcutsCount(long groupId,
                                                                  long folderId,
                                                                  int status,
                                                                  String[] mimeTypes)
                                                           throws RemoteException

Deprecated. As of Athanasius (7.3.x), replaced by getFileEntriesAndFileShortcutsCount(long, long, String[], int)

Throws:

RemoteException

getFileEntriesAndFileShortcutsCount

public static int getFileEntriesAndFileShortcutsCount(long groupId,
                                                      long folderId,
                                                      String[] mimeTypes,
                                                      int status)
                                               throws RemoteException

Throws:

RemoteException

getFolder

public static com.liferay.document.library.kernel.model.DLFolderSoap getFolder(long folderId)
                                                                        throws RemoteException

Throws:

RemoteException

getFolder

public static com.liferay.document.library.kernel.model.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 com.liferay.document.library.kernel.model.DLFolderSoap[] getFolders(long groupId,
                                                                                  long parentFolderId,
                                                                                  boolean includeMountfolders,
                                                                                  int status,
                                                                                  int start,
                                                                                  int end,
                                                                                  com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFolder> orderByComparator)
                                                                           throws RemoteException

Throws:

RemoteException

getFolders

@Deprecated
public static com.liferay.document.library.kernel.model.DLFolderSoap[] getFolders(long groupId,
                                                                                              long parentFolderId,
                                                                                              int status,
                                                                                              boolean includeMountfolders,
                                                                                              int start,
                                                                                              int end,
                                                                                              com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFolder> orderByComparator)
                                                                                       throws RemoteException

Deprecated. As of Athanasius (7.3.x), replaced by getFolders(long, long, boolean, int, int, int, OrderByComparator)

Throws:

RemoteException

getFolders

public static com.liferay.document.library.kernel.model.DLFolderSoap[] getFolders(long groupId,
                                                                                  long parentFolderId,
                                                                                  int start,
                                                                                  int end,
                                                                                  com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFolder> orderByComparator)
                                                                           throws RemoteException

Throws:

RemoteException

getFoldersAndFileEntriesAndFileShortcutsCount

public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                long folderId,
                                                                int status,
                                                                boolean includeMountFolders)
                                                         throws RemoteException

Throws:

RemoteException

getFoldersAndFileEntriesAndFileShortcutsCount

@Deprecated
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                            long folderId,
                                                                            int status,
                                                                            String[] mimeTypes,
                                                                            boolean includeMountFolders)
                                                                     throws RemoteException

Deprecated. As of Athanasius (7.3.x), replaced by getFoldersAndFileEntriesAndFileShortcutsCount(long, long, String[], boolean, int)

Throws:

RemoteException

getFoldersAndFileEntriesAndFileShortcutsCount

public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                long folderId,
                                                                String[] mimeTypes,
                                                                boolean includeMountFolders,
                                                                int status)
                                                         throws RemoteException

Throws:

RemoteException

getFoldersAndFileEntriesAndFileShortcutsCount

public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                long folderId,
                                                                String[] mimeTypes,
                                                                boolean includeMountFolders,
                                                                com.liferay.portal.kernel.dao.orm.QueryDefinition<?> queryDefinition)
                                                         throws RemoteException

Throws:

RemoteException

getFoldersAndFileEntriesAndFileShortcutsCount

public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                long folderId,
                                                                String[] mimeTypes,
                                                                long fileEntryTypeId,
                                                                boolean includeMountFolders,
                                                                int status)
                                                         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,
                                  int status)
                           throws RemoteException

Throws:

RemoteException

getFoldersCount

@Deprecated
public static int getFoldersCount(long groupId,
                                              long parentFolderId,
                                              int status,
                                              boolean includeMountfolders)
                                       throws RemoteException

Deprecated. As of Athanasius (7.3.x), replaced by getFoldersCount(long, long, boolean, int)

Throws:

RemoteException

getMountFolders

public static com.liferay.document.library.kernel.model.DLFolderSoap[] getMountFolders(long groupId,
                                                                                       long parentFolderId,
                                                                                       int start,
                                                                                       int end,
                                                                                       com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFolder> orderByComparator)
                                                                                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,
                                   boolean recurse)
                            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

lockFolder

public static com.liferay.portal.kernel.lock.Lock lockFolder(long folderId)
                                                      throws RemoteException

Throws:

RemoteException

lockFolder

public static com.liferay.portal.kernel.lock.Lock lockFolder(long folderId,
                                                             String owner,
                                                             boolean inheritable,
                                                             long expirationTime)
                                                      throws RemoteException

Throws:

RemoteException

moveFolder

public static com.liferay.document.library.kernel.model.DLFolderSoap moveFolder(long folderId,
                                                                                long parentFolderId,
                                                                                com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                         throws RemoteException

Throws:

RemoteException

refreshFolderLock

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

Throws:

RemoteException

unlockFolder

public static void unlockFolder(long groupId,
                                long parentFolderId,
                                String name,
                                String lockUuid)
                         throws RemoteException

Throws:

RemoteException

unlockFolder

public static void unlockFolder(long folderId,
                                String lockUuid)
                         throws RemoteException

Throws:

RemoteException

updateFolder

public static com.liferay.document.library.kernel.model.DLFolderSoap updateFolder(long folderId,
                                                                                  long parentFolderId,
                                                                                  String name,
                                                                                  String description,
                                                                                  long defaultFileEntryTypeId,
                                                                                  Long[] fileEntryTypeIds,
                                                                                  int restrictionType,
                                                                                  com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                           throws RemoteException

Throws:

RemoteException

updateFolder

public static com.liferay.document.library.kernel.model.DLFolderSoap updateFolder(long folderId,
                                                                                  String name,
                                                                                  String description,
                                                                                  long defaultFileEntryTypeId,
                                                                                  Long[] fileEntryTypeIds,
                                                                                  int restrictionType,
                                                                                  com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                           throws RemoteException

Throws:

RemoteException

verifyInheritableLock

public static boolean verifyInheritableLock(long folderId,
                                            String lockUuid)
                                     throws RemoteException

Throws:

RemoteException