Class TrashEntryServiceUtil

java.lang.Object
com.liferay.trash.service.TrashEntryServiceUtil

public class TrashEntryServiceUtil extends Object
Provides the remote service utility for TrashEntry. This utility wraps com.liferay.trash.service.impl.TrashEntryServiceImpl and is an access point for service operations in application layer code running on a remote server. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
See Also:
Generated:
  • Constructor Details

    • TrashEntryServiceUtil

      public TrashEntryServiceUtil()
  • Method Details

    • deleteEntries

      public static void deleteEntries(long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the trash entries with the matching group ID considering permissions.
      Parameters:
      groupId - the primary key of the group
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteEntries

      public static void deleteEntries(long[] entryIds) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the trash entries with the primary keys.
      Parameters:
      entryIds - the primary keys of the trash entries
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteEntry

      public static void deleteEntry(long entryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the trash entry with the primary key.

      This method throws a

      invalid reference
      TrashPermissionException
      with type
      invalid reference
      TrashPermissionException#DELETE
      if the user did not have permission to delete the trash entry.

      Parameters:
      entryId - the primary key of the trash entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteEntry

      public static void deleteEntry(String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the trash entry with the entity class name and class primary key.

      This method throws a

      invalid reference
      TrashPermissionException
      with type
      invalid reference
      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:
      com.liferay.portal.kernel.exception.PortalException
    • getEntries

      public static TrashEntryList getEntries(long groupId) throws com.liferay.portal.kernel.security.auth.PrincipalException
      Returns the trash entries with the matching group ID.
      Parameters:
      groupId - the primary key of the group
      Returns:
      the matching trash entries
      Throws:
      com.liferay.portal.kernel.security.auth.PrincipalException
    • getEntries

      public static TrashEntryList getEntries(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TrashEntry> orderByComparator) throws com.liferay.portal.kernel.security.auth.PrincipalException
      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)
      orderByComparator - the comparator to order the trash entries (optionally null)
      Returns:
      the range of matching trash entries ordered by comparator orderByComparator
      Throws:
      com.liferay.portal.kernel.security.auth.PrincipalException
    • getEntries

      public static List<TrashEntry> getEntries(long groupId, String className) throws com.liferay.portal.kernel.security.auth.PrincipalException
      Throws:
      com.liferay.portal.kernel.security.auth.PrincipalException
    • getEntries

      public static TrashEntryList getEntries(long groupId, String className, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TrashEntry> orderByComparator) throws com.liferay.portal.kernel.security.auth.PrincipalException
      Returns a range of all the trash entries matching the group ID.
      Parameters:
      groupId - the primary key of the group
      className - the class name of the entity
      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)
      orderByComparator - the comparator to order the trash entries (optionally null)
      Returns:
      the range of matching trash entries ordered by comparator orderByComparator
      Throws:
      com.liferay.portal.kernel.security.auth.PrincipalException
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • moveEntry

      public static void moveEntry(String className, long classPK, long destinationContainerModelId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      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

      invalid reference
      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:

      • invalid reference
        TrashPermissionException#MOVE
        - if the user did not have permission to move the trash entry to the new destination
      • invalid reference
        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:
      com.liferay.portal.kernel.exception.PortalException
    • restoreEntry

      public static TrashEntry restoreEntry(long entryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • restoreEntry

      public static TrashEntry restoreEntry(long entryId, long overrideClassPK, String name) throws com.liferay.portal.kernel.exception.PortalException
      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

      invalid reference
      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:

      • invalid reference
        TrashPermissionException#RESTORE
        - if the user did not have permission to restore the trash entry
      • invalid reference
        TrashPermissionException#RESTORE_OVERWRITE
        - if the user did not have permission to delete the existing trash entry
      • invalid reference
        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:
      com.liferay.portal.kernel.exception.PortalException
    • restoreEntry

      public static TrashEntry restoreEntry(String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • restoreEntry

      public static TrashEntry restoreEntry(String className, long classPK, long overrideClassPK, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static TrashEntryService getService()