com.liferay.portlet.trash.service.impl

Class TrashEntryServiceImpl

Object

com.liferay.portal.kernel.service.BaseServiceImpl

com.liferay.portlet.trash.service.base.TrashEntryServiceBaseImpl

com.liferay.portlet.trash.service.impl.TrashEntryServiceImpl

All Implemented Interfaces:

com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService, com.liferay.portal.kernel.service.BaseService, com.liferay.trash.kernel.service.TrashEntryService

public class TrashEntryServiceImpl
extends TrashEntryServiceBaseImpl

The trash entry remote service is responsible for returning trash entries. For more information on trash entries services and TrashEntry, see TrashEntryLocalServiceImpl.

Author:

Julio Camarero, Zsolt Berentey

Field Summary

Fields inherited from class com.liferay.portlet.trash.service.base.TrashEntryServiceBaseImpl

classNameLocalService, classNamePersistence, classNameService, counterLocalService, groupFinder, groupLocalService, groupPersistence, groupService, resourceLocalService, systemEventLocalService, systemEventPersistence, trashEntryLocalService, trashEntryPersistence, trashEntryService, trashVersionLocalService, trashVersionPersistence, userFinder, userLocalService, userPersistence, userService

Fields inherited from class com.liferay.portal.kernel.service.BaseServiceImpl

ANONYMOUS_NAMES, JRUN_ANONYMOUS, ORACLE_ANONYMOUS, SUN_ANONYMOUS, WEBLOGIC_ANONYMOUS

Constructor Summary

Constructors

Constructor and Description
TrashEntryServiceImpl()

Method Summary

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(String className, long classPK) Deletes the trash entry with the entity class name and class primary key.
protected void	deleteEntry(com.liferay.trash.kernel.model.TrashEntry entry)
protected List<com.liferay.trash.kernel.model.TrashEntry>	filterEntries(List<com.liferay.trash.kernel.model.TrashEntry> entries)
com.liferay.trash.kernel.model.TrashEntryList	getEntries(long groupId) Returns the trash entries with the matching group ID.
com.liferay.trash.kernel.model.TrashEntryList	getEntries(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.trash.kernel.model.TrashEntry> obc) Returns a range of all the trash entries matching the group ID.
List<com.liferay.trash.kernel.model.TrashEntry>	getEntries(long groupId, String className)
void	moveEntry(String className, long classPK, long destinationContainerModelId, com.liferay.portal.kernel.service.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.
com.liferay.trash.kernel.model.TrashEntry	restoreEntry(long entryId)
com.liferay.trash.kernel.model.TrashEntry	restoreEntry(long entryId, long overrideClassPK, String name) Restores the trash entry to its original location.
com.liferay.trash.kernel.model.TrashEntry	restoreEntry(String className, long classPK)
com.liferay.trash.kernel.model.TrashEntry	restoreEntry(String className, long classPK, long overrideClassPK, String name)

Methods inherited from class com.liferay.portlet.trash.service.base.TrashEntryServiceBaseImpl

afterPropertiesSet, destroy, getClassNameLocalService, getClassNamePersistence, getClassNameService, getCounterLocalService, getGroupFinder, getGroupLocalService, getGroupPersistence, getGroupService, getModelClass, getModelClassName, getOSGiServiceIdentifier, getResourceLocalService, getSystemEventLocalService, getSystemEventPersistence, getTrashEntryLocalService, getTrashEntryPersistence, getTrashEntryService, getTrashVersionLocalService, getTrashVersionPersistence, getUserFinder, getUserLocalService, getUserPersistence, getUserService, runSQL, setClassNameLocalService, setClassNamePersistence, setClassNameService, setCounterLocalService, setGroupFinder, setGroupLocalService, setGroupPersistence, setGroupService, setResourceLocalService, setSystemEventLocalService, setSystemEventPersistence, setTrashEntryLocalService, setTrashEntryPersistence, setTrashEntryService, setTrashVersionLocalService, setTrashVersionPersistence, setUserFinder, setUserLocalService, setUserPersistence, setUserService

Methods inherited from class com.liferay.portal.kernel.service.BaseServiceImpl

getClassLoader, getGuestOrUser, getGuestOrUserId, getPermissionChecker, getUser, getUserId

Methods inherited from class Object

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

Constructor Detail

TrashEntryServiceImpl

public TrashEntryServiceImpl()

Method Detail

deleteEntries

@Transactional(noRollbackFor=com.liferay.portal.kernel.exception.TrashPermissionException.class)
public 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

@Transactional(noRollbackFor=com.liferay.portal.kernel.exception.TrashPermissionException.class)
public 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 void deleteEntry(long entryId)
                 throws com.liferay.portal.kernel.exception.PortalException

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:

com.liferay.portal.kernel.exception.PortalException

deleteEntry

public 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 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:

com.liferay.portal.kernel.exception.PortalException

getEntries

public com.liferay.trash.kernel.model.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 com.liferay.trash.kernel.model.TrashEntryList getEntries(long groupId,
                                                                int start,
                                                                int end,
                                                                com.liferay.portal.kernel.util.OrderByComparator<com.liferay.trash.kernel.model.TrashEntry> obc)
                                                         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)

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

Returns:

the range of matching trash entries ordered by comparator obc

Throws:

com.liferay.portal.kernel.security.auth.PrincipalException

getEntries

public List<com.liferay.trash.kernel.model.TrashEntry> getEntries(long groupId,
                                                                  String className)
                                                           throws com.liferay.portal.kernel.security.auth.PrincipalException

Throws:

com.liferay.portal.kernel.security.auth.PrincipalException

moveEntry

public 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 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:

com.liferay.portal.kernel.exception.PortalException

restoreEntry

public com.liferay.trash.kernel.model.TrashEntry restoreEntry(long entryId)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

restoreEntry

public com.liferay.trash.kernel.model.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 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:

com.liferay.portal.kernel.exception.PortalException

restoreEntry

public com.liferay.trash.kernel.model.TrashEntry restoreEntry(String className,
                                                              long classPK)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

restoreEntry

public com.liferay.trash.kernel.model.TrashEntry restoreEntry(String className,
                                                              long classPK,
                                                              long overrideClassPK,
                                                              String name)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteEntry

protected void deleteEntry(com.liferay.trash.kernel.model.TrashEntry entry)
                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

filterEntries

protected List<com.liferay.trash.kernel.model.TrashEntry> filterEntries(List<com.liferay.trash.kernel.model.TrashEntry> entries)
                                                                 throws com.liferay.portal.kernel.security.auth.PrincipalException

Throws:

com.liferay.portal.kernel.security.auth.PrincipalException