com.liferay.trash.kernel.service

Interface TrashEntryLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

TrashEntryLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface TrashEntryLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for TrashEntry. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:

Brian Wing Shun Chan

See Also:

TrashEntryLocalServiceUtil, TrashEntryLocalServiceBaseImpl, TrashEntryLocalServiceImpl

{$generated.description}

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.
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)
TrashEntry	updateTrashEntry(TrashEntry trashEntry) Updates the trash entry in the database or adds it if it does not yet exist.

Method Detail

addTrashEntry

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.

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

@Indexable(type=REINDEX)
TrashEntry addTrashEntry(TrashEntry trashEntry)

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

Parameters:

trashEntry - the trash entry

Returns:

the trash entry that was added

checkEntries

void checkEntries()
           throws PortalException

Throws:

PortalException

createTrashEntry

@Transactional(enabled=false)
TrashEntry createTrashEntry(long entryId)

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

Parameters:

entryId - the primary key for the new trash entry

Returns:

the new trash entry

deleteEntries

void deleteEntries(long groupId)

deleteEntries

void deleteEntries(long groupId,
                   boolean deleteTrashedModels)

deleteEntry

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

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)
TrashEntry deleteEntry(TrashEntry trashEntry)

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteTrashEntry

@Indexable(type=DELETE)
TrashEntry deleteTrashEntry(long entryId)
                                             throws PortalException

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

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

@Indexable(type=DELETE)
TrashEntry deleteTrashEntry(TrashEntry trashEntry)

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

Parameters:

trashEntry - the trash entry

Returns:

the trash entry that was removed

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

fetchTrashEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
TrashEntry fetchTrashEntry(long entryId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<TrashEntry> getEntries(long groupId,
                                                                                               String className)

getEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
TrashEntry getEntry(long entryId)
                                                                                throws 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:

PortalException

getEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
TrashEntry getEntry(String className,
                                                                                       long classPK)
                                                                                throws 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:

PortalException

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getTrashEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getTrashEntriesCount()

Returns the number of trash entries.

Returns:

the number of trash entries

getTrashEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
TrashEntry getTrashEntry(long entryId)
                                                                                     throws PortalException

Returns the trash entry with the primary key.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long companyId,
                                                                               long groupId,
                                                                               long userId,
                                                                               String keywords,
                                                                               int start,
                                                                               int end,
                                                                               Sort sort)

searchTrashEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BaseModelSearchResult<TrashEntry> searchTrashEntries(long companyId,
                                                                                                                        long groupId,
                                                                                                                        long userId,
                                                                                                                        String keywords,
                                                                                                                        int start,
                                                                                                                        int end,
                                                                                                                        Sort sort)

updateTrashEntry

@Indexable(type=REINDEX)
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.

Parameters:

trashEntry - the trash entry

Returns:

the trash entry that was updated