com.liferay.portlet.trash.service.http
Class TrashEntryServiceSoap

java.lang.Object
  com.liferay.portlet.trash.service.http.TrashEntryServiceSoap

@ProviderType
public class TrashEntryServiceSoap
extends Object

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.

See Also:

TrashEntryServiceHttp, TrashEntrySoap, TrashEntryServiceUtil

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

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 obc) Returns a range of all the trash entries matching the group ID.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

TrashEntryServiceSoap

public TrashEntryServiceSoap()

Method Detail

deleteEntries

public static void deleteEntries(long groupId)
                          throws RemoteException

Deletes the trash entries with the matching group ID considering permissions.

Parameters:

groupId - the primary key of the group

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

RemoteException

deleteEntries

public static void deleteEntries(long[] entryIds)
                          throws RemoteException

Deletes the trash entries with the primary keys.

Parameters:

entryIds - the primary keys of the trash entries

Throws:

PortalException - if a trash entry with the primary key could not be found or if the user did not have permission to delete any one of the trash entries

SystemException - if a system exception occurred

RemoteException

deleteEntry

public static void deleteEntry(long entryId)
                        throws RemoteException

Deletes the trash entry with the primary key.

This method throws a TrashPermissionException with type TrashPermissionException#DELETE if the user did not have permission to delete the trash entry.

Parameters:

entryId - the primary key of the trash entry

Throws:

PortalException - if a trash entry with the primary key could not be found or if the user did not have permission to delete the trash entry

SystemException - if a system exception occurred

RemoteException

deleteEntry

public static void deleteEntry(String className,
                               long classPK)
                        throws RemoteException

Deletes the trash entry with the entity class name and class primary key.

This method throws a TrashPermissionException with type TrashPermissionException#DELETE if the user did not have permission to delete the trash entry.

Parameters:

className - the class name of the entity

classPK - the primary key of the entity

Throws:

PortalException - if a trash entry with the entity class name and primary key could not be found or if the user did not have permission to delete the entry

SystemException - if a system exception occurred

RemoteException

getEntries

public static TrashEntryList getEntries(long groupId)
                                 throws RemoteException

Returns the trash entries with the matching group ID.

Parameters:

groupId - the primary key of the group

Returns:

the matching trash entries

Throws:

PrincipalException - if a principal exception occurred

SystemException - if a system exception occurred

RemoteException

getEntries

public static TrashEntryList getEntries(long groupId,
                                        int start,
                                        int end,
                                        OrderByComparator obc)
                                 throws RemoteException

Returns a range of all the trash entries matching the group ID.

Parameters:

groupId - the primary key of the group

start - the lower bound of the range of trash entries to return

end - the upper bound of the range of trash entries to return (not inclusive)

obc - the comparator to order the trash entries (optionally null)

Returns:

the range of matching trash entries ordered by comparator obc

Throws:

PrincipalException - if a system exception occurred

SystemException - if a system exception occurred

RemoteException

moveEntry

public static void moveEntry(String className,
                             long classPK,
                             long destinationContainerModelId,
                             ServiceContext serviceContext)
                      throws RemoteException

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.

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

Parameters:

className - the class name of the entity

classPK - the primary key of the entity

destinationContainerModelId - the primary key of the new location

serviceContext - the service context to be applied (optionally null)

Throws:

PortalException - if a matching trash entry could not be found, if the user did not have permission to move the trash entry to the new location, if the user did not have permission to restore the trash entry, if a duplicate trash entry exists at the new location, or if a portal exception occurred

SystemException - if a system exception occurred

RemoteException

restoreEntry

public static TrashEntrySoap restoreEntry(long entryId)
                                   throws RemoteException

Throws:

RemoteException

restoreEntry

public static TrashEntrySoap restoreEntry(long entryId,
                                          long overrideClassPK,
                                          String name)
                                   throws RemoteException

Restores the trash entry to its original location. In order to handle a duplicate trash entry already existing at the original location, either pass in the primary key of the existing trash entry's entity to overwrite or pass in a new name to give to the trash entry being restored.

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

Parameters:

entryId - the primary key of the trash entry to restore

overrideClassPK - the primary key of the entity to overwrite (optionally 0)

name - a new name to give to the trash entry being restored (optionally null)

Returns:

the restored trash entry

Throws:

PortalException - if a matching trash entry could not be found, if the user did not have permission to overwrite an existing trash entry, to rename the trash entry being restored, or to restore the trash entry in general

SystemException - if a system exception occurred

RemoteException