com.liferay.portlet.trash.service.impl

Class TrashEntryLocalServiceImpl

Object

com.liferay.portal.kernel.service.BaseLocalServiceImpl

com.liferay.portlet.trash.service.base.TrashEntryLocalServiceBaseImpl

com.liferay.portlet.trash.service.impl.TrashEntryLocalServiceImpl

All Implemented Interfaces:

com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService, com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService, com.liferay.trash.kernel.service.TrashEntryLocalService

public class TrashEntryLocalServiceImpl
extends TrashEntryLocalServiceBaseImpl

Provides the local service for accessing, adding, checking, and deleting trash entries in the Recycle Bin.

Author:

Zsolt Berentey

Field Summary

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

classNameLocalService, classNamePersistence, counterLocalService, groupFinder, groupLocalService, groupPersistence, persistedModelLocalServiceRegistry, resourceLocalService, systemEventLocalService, systemEventPersistence, trashEntryLocalService, trashEntryPersistence, trashVersionLocalService, trashVersionPersistence, userFinder, userLocalService, userPersistence

Constructor Summary

Constructors

Constructor and Description
TrashEntryLocalServiceImpl()

Method Summary

Modifier and Type	Method and Description
com.liferay.trash.kernel.model.TrashEntry	addTrashEntry(long userId, long groupId, String className, long classPK, String classUuid, String referrerClassName, int status, List<com.liferay.portal.kernel.util.ObjectValuePair<Long,Integer>> statusOVPs, com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties) Moves an entry to trash.
protected com.liferay.portal.kernel.search.SearchContext	buildSearchContext(long companyId, long groupId, long userId, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort)
void	checkEntries()
void	deleteEntries(long groupId)
void	deleteEntries(long groupId, boolean deleteTrashedModels)
com.liferay.trash.kernel.model.TrashEntry	deleteEntry(long entryId) Deletes the trash entry with the primary key.
com.liferay.trash.kernel.model.TrashEntry	deleteEntry(String className, long classPK) Deletes the trash entry with the entity class name and primary key.
com.liferay.trash.kernel.model.TrashEntry	deleteEntry(com.liferay.trash.kernel.model.TrashEntry trashEntry)
com.liferay.trash.kernel.model.TrashEntry	fetchEntry(long entryId) Returns the trash entry with the primary key.
com.liferay.trash.kernel.model.TrashEntry	fetchEntry(String className, long classPK) Returns the trash entry with the entity class name and primary key.
List<com.liferay.trash.kernel.model.TrashEntry>	getEntries(long groupId) Returns the trash entries with the matching group ID.
List<com.liferay.trash.kernel.model.TrashEntry>	getEntries(long groupId, int start, int end) Returns a range of all the trash entries matching the group ID.
List<com.liferay.trash.kernel.model.TrashEntry>	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)
int	getEntriesCount(long groupId) Returns the number of trash entries with the group ID.
com.liferay.trash.kernel.model.TrashEntry	getEntry(long entryId) Returns the trash entry with the primary key.
com.liferay.trash.kernel.model.TrashEntry	getEntry(String className, long classPK) Returns the entry with the entity class name and primary key.
protected Date	getMaxAge(com.liferay.portal.kernel.model.Group group)
com.liferay.portal.kernel.search.Hits	search(long companyId, long groupId, long userId, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort)
com.liferay.portal.kernel.search.BaseModelSearchResult<com.liferay.trash.kernel.model.TrashEntry>	searchTrashEntries(long companyId, long groupId, long userId, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort)

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

addTrashEntry, afterPropertiesSet, createTrashEntry, deletePersistedModel, deleteTrashEntry, deleteTrashEntry, destroy, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQueryCount, dynamicQueryCount, fetchTrashEntry, getActionableDynamicQuery, getClassNameLocalService, getClassNamePersistence, getCounterLocalService, getGroupFinder, getGroupLocalService, getGroupPersistence, getIndexableActionableDynamicQuery, getModelClass, getModelClassName, getOSGiServiceIdentifier, getPersistedModel, getResourceLocalService, getSystemEventLocalService, getSystemEventPersistence, getTrashEntries, getTrashEntriesCount, getTrashEntry, getTrashEntryLocalService, getTrashEntryPersistence, getTrashVersionLocalService, getTrashVersionPersistence, getUserFinder, getUserLocalService, getUserPersistence, initActionableDynamicQuery, runSQL, setClassNameLocalService, setClassNamePersistence, setCounterLocalService, setGroupFinder, setGroupLocalService, setGroupPersistence, setResourceLocalService, setSystemEventLocalService, setSystemEventPersistence, setTrashEntryLocalService, setTrashEntryPersistence, setTrashVersionLocalService, setTrashVersionPersistence, setUserFinder, setUserLocalService, setUserPersistence, updateTrashEntry

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

getClassLoader, getLocalizationMap

Methods inherited from class Object

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

Constructor Detail

TrashEntryLocalServiceImpl

public TrashEntryLocalServiceImpl()

Method Detail

addTrashEntry

public com.liferay.trash.kernel.model.TrashEntry addTrashEntry(long userId,
                                                               long groupId,
                                                               String className,
                                                               long classPK,
                                                               String classUuid,
                                                               String referrerClassName,
                                                               int status,
                                                               List<com.liferay.portal.kernel.util.ObjectValuePair<Long,Integer>> statusOVPs,
                                                               com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties)
                                                        throws com.liferay.portal.kernel.exception.PortalException

Moves an entry to trash.

Parameters:

userId - the primary key of the user removing the entity

groupId - the primary key of the entry's group

className - the class name of the entity

classPK - the primary key of the entity

classUuid - the UUID of the entity's class

referrerClassName - the referrer class name used to add a deletion SystemEvent

status - the status of the entity prior to being moved to trash

statusOVPs - the primary keys and statuses of any of the entry's versions (e.g., com.liferay.portlet.documentlibrary.model.DLFileVersion)

typeSettingsProperties - the type settings properties

Returns:

the trashEntry

Throws:

com.liferay.portal.kernel.exception.PortalException

checkEntries

public void checkEntries()
                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteEntries

public void deleteEntries(long groupId)

deleteEntries

public void deleteEntries(long groupId,
                          boolean deleteTrashedModels)

deleteEntry

public com.liferay.trash.kernel.model.TrashEntry deleteEntry(long entryId)

Deletes the trash entry with the primary key.

Parameters:

entryId - the primary key of the trash entry

Returns:

the trash entry with the primary key

deleteEntry

public com.liferay.trash.kernel.model.TrashEntry deleteEntry(String className,
                                                             long classPK)

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

Parameters:

className - the class name of entity

classPK - the primary key of the entry

Returns:

the trash entry with the entity class name and primary key

deleteEntry

@Indexable(type=DELETE)
public com.liferay.trash.kernel.model.TrashEntry deleteEntry(com.liferay.trash.kernel.model.TrashEntry trashEntry)

fetchEntry

public com.liferay.trash.kernel.model.TrashEntry fetchEntry(long entryId)

Returns the trash entry with the primary key.

Parameters:

entryId - the primary key of the entry

Returns:

the trash entry with the primary key

fetchEntry

public com.liferay.trash.kernel.model.TrashEntry fetchEntry(String className,
                                                            long classPK)

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

Parameters:

className - the class name of the entity

classPK - the primary key of the entity

Returns:

the trash entry with the entity class name and primary key

getEntries

public List<com.liferay.trash.kernel.model.TrashEntry> getEntries(long groupId)

Returns the trash entries with the matching group ID.

Parameters:

groupId - the primary key of the group

Returns:

the trash entries with the group ID

getEntries

public List<com.liferay.trash.kernel.model.TrashEntry> getEntries(long groupId,
                                                                  int start,
                                                                  int end)

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)

Returns:

the range of matching trash entries

getEntries

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

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

getEntries

public List<com.liferay.trash.kernel.model.TrashEntry> getEntries(long groupId,
                                                                  String className)

getEntriesCount

public int getEntriesCount(long groupId)

Returns the number of trash entries with the group ID.

Parameters:

groupId - the primary key of the group

Returns:

the number of matching trash entries

getEntry

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

Returns the trash entry with the primary key.

Parameters:

entryId - the primary key of the trash entry

Returns:

the trash entry with the primary key

Throws:

com.liferay.portal.kernel.exception.PortalException

getEntry

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

Returns the entry with the entity class name and primary key.

Parameters:

className - the class name of the entity

classPK - the primary key of the entity

Returns:

the trash entry with the entity class name and primary key

Throws:

com.liferay.portal.kernel.exception.PortalException

search

public com.liferay.portal.kernel.search.Hits search(long companyId,
                                                    long groupId,
                                                    long userId,
                                                    String keywords,
                                                    int start,
                                                    int end,
                                                    com.liferay.portal.kernel.search.Sort sort)

searchTrashEntries

public com.liferay.portal.kernel.search.BaseModelSearchResult<com.liferay.trash.kernel.model.TrashEntry> searchTrashEntries(long companyId,
                                                                                                                            long groupId,
                                                                                                                            long userId,
                                                                                                                            String keywords,
                                                                                                                            int start,
                                                                                                                            int end,
                                                                                                                            com.liferay.portal.kernel.search.Sort sort)

buildSearchContext

protected com.liferay.portal.kernel.search.SearchContext buildSearchContext(long companyId,
                                                                            long groupId,
                                                                            long userId,
                                                                            String keywords,
                                                                            int start,
                                                                            int end,
                                                                            com.liferay.portal.kernel.search.Sort sort)

getMaxAge

protected Date getMaxAge(com.liferay.portal.kernel.model.Group group)
                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException