com.liferay.portlet.trash.service

Interface TrashEntryService

All Superinterfaces:

BaseService

All Known Implementing Classes:

TrashEntryServiceWrapper

@ProviderType
@AccessControlled
@JSONWebService
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface TrashEntryService
extends BaseService

Provides the remote service interface for TrashEntry. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

Author:

Brian Wing Shun Chan

See Also:

TrashEntryServiceUtil, com.liferay.portlet.trash.service.base.TrashEntryServiceBaseImpl, com.liferay.portlet.trash.service.impl.TrashEntryServiceImpl

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteEntries(long groupId) Deletes the trash entries with the matching group ID considering permissions.
void	deleteEntries(long[] entryIds) Deletes the trash entries with the primary keys.
void	deleteEntry(long entryId) Deletes the trash entry with the primary key.
void	deleteEntry(java.lang.String className, long classPK) Deletes the trash entry with the entity class name and class primary key.
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
TrashEntryList	getEntries(long groupId) Returns the trash entries with the matching group ID.
TrashEntryList	getEntries(long groupId, int start, int end, OrderByComparator obc) Returns a range of all the trash entries matching the group ID.
void	moveEntry(java.lang.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.
TrashEntry	restoreEntry(long entryId)
TrashEntry	restoreEntry(long entryId, long overrideClassPK, java.lang.String name) Restores the trash entry to its original location.
void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.

Method Detail

getBeanIdentifier

java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

deleteEntries

@Transactional(noRollbackFor=TrashPermissionException.class)
void deleteEntries(long groupId)
                   throws PortalException,
                          SystemException

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

deleteEntries

@Transactional(noRollbackFor=TrashPermissionException.class)
void deleteEntries(long[] entryIds)
                   throws PortalException,
                          SystemException

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

deleteEntry

void deleteEntry(long entryId)
                 throws PortalException,
                        SystemException

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

deleteEntry

void deleteEntry(java.lang.String className,
               long classPK)
                 throws PortalException,
                        SystemException

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

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
TrashEntryList getEntries(long groupId)
                          throws SystemException,
                                 PrincipalException

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

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
TrashEntryList getEntries(long groupId,
                                                                 int start,
                                                                 int end,
                                                                 OrderByComparator obc)
                          throws SystemException,
                                 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)

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

moveEntry

void moveEntry(java.lang.String className,
             long classPK,
             long destinationContainerModelId,
             ServiceContext serviceContext)
               throws PortalException,
                      SystemException

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

restoreEntry

TrashEntry restoreEntry(long entryId)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

restoreEntry

TrashEntry restoreEntry(long entryId,
                      long overrideClassPK,
                      java.lang.String name)
                        throws PortalException,
                               SystemException

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