com.liferay.trash.kernel.service

Class TrashEntryLocalServiceWrapper

Object

com.liferay.trash.kernel.service.TrashEntryLocalServiceWrapper

All Implemented Interfaces:

BaseLocalService, PersistedModelLocalService, ServiceWrapper<TrashEntryLocalService>, TrashEntryLocalService

@ProviderType
public class TrashEntryLocalServiceWrapper
extends Object
implements TrashEntryLocalService, ServiceWrapper<TrashEntryLocalService>

Provides a wrapper for TrashEntryLocalService.

Author:

Brian Wing Shun Chan

See Also:

TrashEntryLocalService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
TrashEntryLocalServiceWrapper(TrashEntryLocalService trashEntryLocalService)

Method Summary

Modifier and Type	Method and Description
TrashEntry	addTrashEntry(long userId, long groupId, String className, long classPK, String classUuid, String referrerClassName, int status, List<ObjectValuePair<Long,Integer>> statusOVPs, UnicodeProperties typeSettingsProperties) Moves an entry to trash.
TrashEntry	addTrashEntry(TrashEntry trashEntry) Adds the trash entry to the database.
void	checkEntries()
TrashEntry	createTrashEntry(long entryId) Creates a new trash entry with the primary key.
void	deleteEntries(long groupId)
void	deleteEntries(long groupId, boolean deleteTrashedModels)
TrashEntry	deleteEntry(long entryId) Deletes the trash entry with the primary key.
TrashEntry	deleteEntry(String className, long classPK) Deletes the trash entry with the entity class name and primary key.
TrashEntry	deleteEntry(TrashEntry trashEntry)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
TrashEntry	deleteTrashEntry(long entryId) Deletes the trash entry with the primary key from the database.
TrashEntry	deleteTrashEntry(TrashEntry trashEntry) Deletes the trash entry from the database.
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
TrashEntry	fetchEntry(long entryId) Returns the trash entry with the primary key.
TrashEntry	fetchEntry(String className, long classPK) Returns the trash entry with the entity class name and primary key.
TrashEntry	fetchTrashEntry(long entryId)
ActionableDynamicQuery	getActionableDynamicQuery()
List<TrashEntry>	getEntries(long groupId) Returns the trash entries with the matching group ID.
List<TrashEntry>	getEntries(long groupId, int start, int end) Returns a range of all the trash entries matching the group ID.
List<TrashEntry>	getEntries(long groupId, int start, int end, OrderByComparator<TrashEntry> obc) Returns a range of all the trash entries matching the group ID.
List<TrashEntry>	getEntries(long groupId, String className)
int	getEntriesCount(long groupId) Returns the number of trash entries with the group ID.
TrashEntry	getEntry(long entryId) Returns the trash entry with the primary key.
TrashEntry	getEntry(String className, long classPK) Returns the entry with the entity class name and primary key.
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
List<TrashEntry>	getTrashEntries(int start, int end) Returns a range of all the trash entries.
int	getTrashEntriesCount() Returns the number of trash entries.
TrashEntry	getTrashEntry(long entryId) Returns the trash entry with the primary key.
TrashEntryLocalService	getWrappedService()
Hits	search(long companyId, long groupId, long userId, String keywords, int start, int end, Sort sort)
BaseModelSearchResult<TrashEntry>	searchTrashEntries(long companyId, long groupId, long userId, String keywords, int start, int end, Sort sort)
void	setWrappedService(TrashEntryLocalService trashEntryLocalService)
TrashEntry	updateTrashEntry(TrashEntry trashEntry) Updates the trash entry in the database or adds it if it does not yet exist.

Methods inherited from class Object

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

Constructor Detail

TrashEntryLocalServiceWrapper

public TrashEntryLocalServiceWrapper(TrashEntryLocalService trashEntryLocalService)

Method Detail

addTrashEntry

public TrashEntry addTrashEntry(long userId,
                                long groupId,
                                String className,
                                long classPK,
                                String classUuid,
                                String referrerClassName,
                                int status,
                                List<ObjectValuePair<Long,Integer>> statusOVPs,
                                UnicodeProperties typeSettingsProperties)
                         throws PortalException

Moves an entry to trash.

Specified by:

addTrashEntry in interface TrashEntryLocalService

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:

PortalException

addTrashEntry

public TrashEntry addTrashEntry(TrashEntry trashEntry)

Adds the trash entry to the database. Also notifies the appropriate model listeners.

Specified by:

addTrashEntry in interface TrashEntryLocalService

Parameters:

trashEntry - the trash entry

Returns:

the trash entry that was added

checkEntries

public void checkEntries()
                  throws PortalException

Specified by:

checkEntries in interface TrashEntryLocalService

Throws:

PortalException

createTrashEntry

public TrashEntry createTrashEntry(long entryId)

Creates a new trash entry with the primary key. Does not add the trash entry to the database.

Specified by:

createTrashEntry in interface TrashEntryLocalService

Parameters:

entryId - the primary key for the new trash entry

Returns:

the new trash entry

deleteEntries

public void deleteEntries(long groupId)

Specified by:

deleteEntries in interface TrashEntryLocalService

deleteEntries

public void deleteEntries(long groupId,
                          boolean deleteTrashedModels)

Specified by:

deleteEntries in interface TrashEntryLocalService

deleteEntry

public TrashEntry deleteEntry(long entryId)

Deletes the trash entry with the primary key.

Specified by:

deleteEntry in interface TrashEntryLocalService

Parameters:

entryId - the primary key of the trash entry

Returns:

the trash entry with the primary key

deleteEntry

public TrashEntry deleteEntry(String className,
                              long classPK)

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

Specified by:

deleteEntry in interface TrashEntryLocalService

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

public TrashEntry deleteEntry(TrashEntry trashEntry)

Specified by:

deleteEntry in interface TrashEntryLocalService

deletePersistedModel

public PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Specified by:

deletePersistedModel in interface TrashEntryLocalService

Throws:

PortalException

deleteTrashEntry

public TrashEntry deleteTrashEntry(long entryId)
                            throws PortalException

Deletes the trash entry with the primary key from the database. Also notifies the appropriate model listeners.

Specified by:

deleteTrashEntry in interface TrashEntryLocalService

Parameters:

entryId - the primary key of the trash entry

Returns:

the trash entry that was removed

Throws:

PortalException - if a trash entry with the primary key could not be found

deleteTrashEntry

public TrashEntry deleteTrashEntry(TrashEntry trashEntry)

Deletes the trash entry from the database. Also notifies the appropriate model listeners.

Specified by:

deleteTrashEntry in interface TrashEntryLocalService

Parameters:

trashEntry - the trash entry

Returns:

the trash entry that was removed

dynamicQuery

public DynamicQuery dynamicQuery()

Specified by:

dynamicQuery in interface TrashEntryLocalService

dynamicQuery

public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Specified by:

dynamicQuery in interface TrashEntryLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from TrashEntryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Specified by:

dynamicQuery in interface TrashEntryLocalService

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from TrashEntryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Specified by:

dynamicQuery in interface TrashEntryLocalService

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Specified by:

dynamicQueryCount in interface TrashEntryLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery,
                              Projection projection)

Returns the number of rows matching the dynamic query.

Specified by:

dynamicQueryCount in interface TrashEntryLocalService

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchEntry

public TrashEntry fetchEntry(long entryId)

Returns the trash entry with the primary key.

Specified by:

fetchEntry in interface TrashEntryLocalService

Parameters:

entryId - the primary key of the entry

Returns:

the trash entry with the primary key

fetchEntry

public TrashEntry fetchEntry(String className,
                             long classPK)

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

Specified by:

fetchEntry in interface TrashEntryLocalService

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

fetchTrashEntry

public TrashEntry fetchTrashEntry(long entryId)

Specified by:

fetchTrashEntry in interface TrashEntryLocalService

getActionableDynamicQuery

public ActionableDynamicQuery getActionableDynamicQuery()

Specified by:

getActionableDynamicQuery in interface TrashEntryLocalService

getEntries

public List<TrashEntry> getEntries(long groupId)

Returns the trash entries with the matching group ID.

Specified by:

getEntries in interface TrashEntryLocalService

Parameters:

groupId - the primary key of the group

Returns:

the trash entries with the group ID

getEntries

public List<TrashEntry> getEntries(long groupId,
                                   int start,
                                   int end)

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

Specified by:

getEntries in interface TrashEntryLocalService

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<TrashEntry> getEntries(long groupId,
                                   int start,
                                   int end,
                                   OrderByComparator<TrashEntry> obc)

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

Specified by:

getEntries in interface TrashEntryLocalService

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<TrashEntry> getEntries(long groupId,
                                   String className)

Specified by:

getEntries in interface TrashEntryLocalService

getEntriesCount

public int getEntriesCount(long groupId)

Returns the number of trash entries with the group ID.

Specified by:

getEntriesCount in interface TrashEntryLocalService

Parameters:

groupId - the primary key of the group

Returns:

the number of matching trash entries

getEntry

public TrashEntry getEntry(long entryId)
                    throws PortalException

Returns the trash entry with the primary key.

Specified by:

getEntry in interface TrashEntryLocalService

Parameters:

entryId - the primary key of the trash entry

Returns:

the trash entry with the primary key

Throws:

PortalException

getEntry

public TrashEntry getEntry(String className,
                           long classPK)
                    throws PortalException

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

Specified by:

getEntry in interface TrashEntryLocalService

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:

PortalException

getIndexableActionableDynamicQuery

public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

Specified by:

getIndexableActionableDynamicQuery in interface TrashEntryLocalService

getOSGiServiceIdentifier

public String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Specified by:

getOSGiServiceIdentifier in interface TrashEntryLocalService

Returns:

the OSGi service identifier

getPersistedModel

public PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Specified by:

getPersistedModel in interface TrashEntryLocalService

Throws:

PortalException

getTrashEntries

public List<TrashEntry> getTrashEntries(int start,
                                        int end)

Returns a range of all the trash entries.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from TrashEntryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Specified by:

getTrashEntries in interface TrashEntryLocalService

Parameters:

start - the lower bound of the range of trash entries

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

Returns:

the range of trash entries

getTrashEntriesCount

public int getTrashEntriesCount()

Returns the number of trash entries.

Specified by:

getTrashEntriesCount in interface TrashEntryLocalService

Returns:

the number of trash entries

getTrashEntry

public TrashEntry getTrashEntry(long entryId)
                         throws PortalException

Returns the trash entry with the primary key.

Specified by:

getTrashEntry in interface TrashEntryLocalService

Parameters:

entryId - the primary key of the trash entry

Returns:

the trash entry

Throws:

PortalException - if a trash entry with the primary key could not be found

search

public Hits search(long companyId,
                   long groupId,
                   long userId,
                   String keywords,
                   int start,
                   int end,
                   Sort sort)

Specified by:

search in interface TrashEntryLocalService

searchTrashEntries

public BaseModelSearchResult<TrashEntry> searchTrashEntries(long companyId,
                                                            long groupId,
                                                            long userId,
                                                            String keywords,
                                                            int start,
                                                            int end,
                                                            Sort sort)

Specified by:

searchTrashEntries in interface TrashEntryLocalService

updateTrashEntry

public TrashEntry updateTrashEntry(TrashEntry trashEntry)

Updates the trash entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:

updateTrashEntry in interface TrashEntryLocalService

Parameters:

trashEntry - the trash entry

Returns:

the trash entry that was updated

getWrappedService

public TrashEntryLocalService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<TrashEntryLocalService>

setWrappedService

public void setWrappedService(TrashEntryLocalService trashEntryLocalService)

Specified by:

setWrappedService in interface ServiceWrapper<TrashEntryLocalService>