|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portlet.trash.service.http.TrashEntryServiceSoap
@ProviderType public class TrashEntryServiceSoap
Provides the SOAP utility for the
TrashEntryServiceUtil 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 TrashEntrySoap.
If the method in the service utility returns a
TrashEntry, that is translated to a
TrashEntrySoap. 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.
TrashEntryServiceHttp,
TrashEntrySoap,
TrashEntryServiceUtil| Constructor Summary | |
|---|---|
TrashEntryServiceSoap()
|
|
| Method Summary | |
|---|---|
static void |
deleteEntries(long groupId)
Deletes the trash entries with the matching group ID considering permissions. |
static void |
deleteEntries(long[] entryIds)
Deletes the trash entries with the primary keys. |
static void |
deleteEntry(long entryId)
Deletes the trash entry with the primary key. |
static void |
deleteEntry(String className,
long classPK)
Deletes the trash entry with the entity class name and class primary key. |
static TrashEntryList |
getEntries(long groupId)
Returns the trash entries with the matching group ID. |
static TrashEntryList |
getEntries(long groupId,
int start,
int end,
OrderByComparator<TrashEntry> obc)
Returns a range of all the trash entries matching the group ID. |
static TrashEntrySoap[] |
getEntries(long groupId,
String className)
|
static void |
moveEntry(String className,
long classPK,
long destinationContainerModelId,
ServiceContext serviceContext)
Moves the trash entry with the entity class name and primary key, restoring it to a new location identified by the destination container model ID. |
static TrashEntrySoap |
restoreEntry(long entryId)
|
static TrashEntrySoap |
restoreEntry(long entryId,
long overrideClassPK,
String name)
Restores the trash entry to its original location. |
static TrashEntrySoap |
restoreEntry(String className,
long classPK)
|
static TrashEntrySoap |
restoreEntry(String className,
long classPK,
long overrideClassPK,
String name)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public TrashEntryServiceSoap()
| Method Detail |
|---|
public static void deleteEntries(long groupId)
throws RemoteException
groupId - the primary key of the group
RemoteException
public static void deleteEntries(long[] entryIds)
throws RemoteException
entryIds - the primary keys of the trash entries
RemoteException
public static void deleteEntry(long entryId)
throws RemoteException
This method throws a TrashPermissionException with type TrashPermissionException#DELETE if the user did not have permission to
delete the trash entry.
entryId - the primary key of the trash entry
RemoteException
public static void deleteEntry(String className,
long classPK)
throws RemoteException
This method throws a TrashPermissionException with type TrashPermissionException#DELETE if the user did not have permission to
delete the trash entry.
className - the class name of the entityclassPK - the primary key of the entity
RemoteException
public static TrashEntryList getEntries(long groupId)
throws RemoteException
groupId - the primary key of the group
RemoteException
public static TrashEntryList getEntries(long groupId,
int start,
int end,
OrderByComparator<TrashEntry> obc)
throws RemoteException
groupId - the primary key of the groupstart - the lower bound of the range of trash entries to returnend - the upper bound of the range of trash entries to return (not
inclusive)obc - the comparator to order the trash entries (optionally
null)
obc
RemoteException
public static TrashEntrySoap[] getEntries(long groupId,
String className)
throws RemoteException
RemoteException
public static void moveEntry(String className,
long classPK,
long destinationContainerModelId,
ServiceContext serviceContext)
throws RemoteException
This method throws a TrashPermissionException if the user did not
have the permission to perform one of the necessary operations. The
exception is created with a type specific to the operation:
TrashPermissionException#MOVE - if the user did not have
permission to move the trash entry to the new
destination
TrashPermissionException#RESTORE - if the user did not have
permission to restore the trash entry
className - the class name of the entityclassPK - the primary key of the entitydestinationContainerModelId - the primary key of the new locationserviceContext - the service context to be applied (optionally
null)
RemoteException
public static TrashEntrySoap restoreEntry(long entryId)
throws RemoteException
RemoteException
public static TrashEntrySoap restoreEntry(long entryId,
long overrideClassPK,
String name)
throws RemoteException
This method throws a TrashPermissionException if the user did not
have the permission to perform one of the necessary operations. The
exception is created with a type specific to the operation:
TrashPermissionException#RESTORE - if the user did not have
permission to restore the trash entry
TrashPermissionException#RESTORE_OVERWRITE - if the user did not
have permission to delete the existing trash entry
TrashPermissionException#RESTORE_RENAME - if the user did not
have permission to rename the trash entry
entryId - the primary key of the trash entry to restoreoverrideClassPK - the primary key of the entity to overwrite
(optionally 0)name - a new name to give to the trash entry being restored
(optionally null)
RemoteException
public static TrashEntrySoap restoreEntry(String className,
long classPK)
throws RemoteException
RemoteException
public static TrashEntrySoap restoreEntry(String className,
long classPK,
long overrideClassPK,
String name)
throws RemoteException
RemoteException
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||