com.liferay.portlet.trash.service
Class TrashEntryLocalServiceWrapper

java.lang.Object
  com.liferay.portlet.trash.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.

See Also:

TrashEntryLocalService

Constructor Summary

TrashEntryLocalServiceWrapper(TrashEntryLocalService trashEntryLocalService)

Method Summary

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)
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)
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()
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match 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)
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
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 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.
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()
TrashEntryLocalService	getWrappedTrashEntryLocalService() Deprecated. As of 6.1.0, replaced by getWrappedService()
Hits	search(long companyId, long groupId, long userId, String keywords, int start, int end, Sort sort)
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setWrappedService(TrashEntryLocalService trashEntryLocalService)
void	setWrappedTrashEntryLocalService(TrashEntryLocalService trashEntryLocalService) Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portlet.trash.service.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 java.lang.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(TrashEntry trashEntry)
                         throws SystemException

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

Throws:

SystemException - if a system exception occurred

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

deleteTrashEntry

public TrashEntry deleteTrashEntry(long entryId)
                            throws PortalException,
                                   SystemException

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

SystemException - if a system exception occurred

deleteTrashEntry

public TrashEntry deleteTrashEntry(TrashEntry trashEntry)
                            throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public DynamicQuery dynamicQuery()

Specified by:

dynamicQuery in interface TrashEntryLocalService

dynamicQuery

public List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public List dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end)
                  throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public List dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end,
                         OrderByComparator orderByComparator)
                  throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Specified by:

dynamicQueryCount in interface TrashEntryLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery,
                              Projection projection)
                       throws SystemException

Returns the number of rows that match 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 that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchTrashEntry

public TrashEntry fetchTrashEntry(long entryId)
                           throws SystemException

Specified by:

fetchTrashEntry in interface TrashEntryLocalService

Throws:

SystemException

getTrashEntry

public TrashEntry getTrashEntry(long entryId)
                         throws PortalException,
                                SystemException

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

SystemException - if a system exception occurred

getPersistedModel

public PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Specified by:

getPersistedModel in interface TrashEntryLocalService

Throws:

PortalException

SystemException

getTrashEntries

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

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

Throws:

SystemException - if a system exception occurred

getTrashEntriesCount

public int getTrashEntriesCount()
                         throws SystemException

Returns the number of trash entries.

Specified by:

getTrashEntriesCount in interface TrashEntryLocalService

Returns:

the number of trash entries

Throws:

SystemException - if a system exception occurred

updateTrashEntry

public TrashEntry updateTrashEntry(TrashEntry trashEntry)
                            throws SystemException

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

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Specified by:

getBeanIdentifier in interface TrashEntryLocalService

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Specified by:

setBeanIdentifier in interface TrashEntryLocalService

Parameters:

beanIdentifier - the Spring bean ID for this bean

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,
                                SystemException

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

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., DLFileVersion)

typeSettingsProperties - the type settings properties

Returns:

the trashEntry

Throws:

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

SystemException - if a system exception occurred

checkEntries

public void checkEntries()
                  throws PortalException,
                         SystemException

Specified by:

checkEntries in interface TrashEntryLocalService

Throws:

PortalException

SystemException

deleteEntries

public void deleteEntries(long groupId)
                   throws SystemException

Specified by:

deleteEntries in interface TrashEntryLocalService

Throws:

SystemException

deleteEntry

public TrashEntry deleteEntry(long entryId)
                       throws PortalException,
                              SystemException

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

Throws:

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

SystemException - if a system exception occurred

deleteEntry

public TrashEntry deleteEntry(String className,
                              long classPK)
                       throws PortalException,
                              SystemException

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

Throws:

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

SystemException - if a system exception occurred

deleteEntry

public TrashEntry deleteEntry(TrashEntry trashEntry)
                       throws SystemException

Specified by:

deleteEntry in interface TrashEntryLocalService

Throws:

SystemException

fetchEntry

public TrashEntry fetchEntry(long entryId)
                      throws SystemException

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

Throws:

SystemException - if a system exception occurred

fetchEntry

public TrashEntry fetchEntry(String className,
                             long classPK)
                      throws SystemException

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

Throws:

SystemException - if a system exception occurred

getEntries

public List<TrashEntry> getEntries(long groupId)
                            throws SystemException

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

Throws:

SystemException - if a system exception occurred

getEntries

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

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

Throws:

SystemException - if a system exception occurred

getEntries

public List<TrashEntry> getEntries(long groupId,
                                   int start,
                                   int end,
                                   OrderByComparator obc)
                            throws SystemException

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

Throws:

SystemException - if a system exception occurred

getEntries

public List<TrashEntry> getEntries(long groupId,
                                   String className)
                            throws SystemException

Specified by:

getEntries in interface TrashEntryLocalService

Throws:

SystemException

getEntriesCount

public int getEntriesCount(long groupId)
                    throws SystemException

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

Throws:

SystemException - if a system exception occurred

getEntry

public TrashEntry getEntry(long entryId)
                    throws PortalException,
                           SystemException

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 - if a trash entry with the primary key could not be found

SystemException - if a system exception occurred

getEntry

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

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 - if a trash entry with the primary key could not be found

SystemException - if a system exception occurred

search

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

Specified by:

search in interface TrashEntryLocalService

Throws:

SystemException

getWrappedTrashEntryLocalService

public TrashEntryLocalService getWrappedTrashEntryLocalService()

Deprecated. As of 6.1.0, replaced by getWrappedService()

setWrappedTrashEntryLocalService

public void setWrappedTrashEntryLocalService(TrashEntryLocalService trashEntryLocalService)

Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portlet.trash.service.TrashEntryLocalService)

getWrappedService

public TrashEntryLocalService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<TrashEntryLocalService>

setWrappedService

public void setWrappedService(TrashEntryLocalService trashEntryLocalService)

Specified by:

setWrappedService in interface ServiceWrapper<TrashEntryLocalService>