com.liferay.trash.kernel.service

Class TrashEntryLocalServiceUtil

Object

com.liferay.trash.kernel.service.TrashEntryLocalServiceUtil

@ProviderType
public class TrashEntryLocalServiceUtil
extends Object

Provides the local service utility for TrashEntry. This utility wraps TrashEntryLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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:

TrashEntryLocalService, TrashEntryLocalServiceBaseImpl, TrashEntryLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
TrashEntryLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static 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.
static TrashEntry	addTrashEntry(TrashEntry trashEntry) Adds the trash entry to the database.
static void	checkEntries()
static TrashEntry	createTrashEntry(long entryId) Creates a new trash entry with the primary key.
static void	deleteEntries(long groupId)
static void	deleteEntries(long groupId, boolean deleteTrashedModels)
static TrashEntry	deleteEntry(long entryId) Deletes the trash entry with the primary key.
static TrashEntry	deleteEntry(String className, long classPK) Deletes the trash entry with the entity class name and primary key.
static TrashEntry	deleteEntry(TrashEntry trashEntry)
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static TrashEntry	deleteTrashEntry(long entryId) Deletes the trash entry with the primary key from the database.
static TrashEntry	deleteTrashEntry(TrashEntry trashEntry) Deletes the trash entry from the database.
static DynamicQuery	dynamicQuery()
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <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.
static <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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static TrashEntry	fetchEntry(long entryId) Returns the trash entry with the primary key.
static TrashEntry	fetchEntry(String className, long classPK) Returns the trash entry with the entity class name and primary key.
static TrashEntry	fetchTrashEntry(long entryId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static List<TrashEntry>	getEntries(long groupId) Returns the trash entries with the matching group ID.
static List<TrashEntry>	getEntries(long groupId, int start, int end) Returns a range of all the trash entries matching the group ID.
static List<TrashEntry>	getEntries(long groupId, int start, int end, OrderByComparator<TrashEntry> obc) Returns a range of all the trash entries matching the group ID.
static List<TrashEntry>	getEntries(long groupId, String className)
static int	getEntriesCount(long groupId) Returns the number of trash entries with the group ID.
static TrashEntry	getEntry(long entryId) Returns the trash entry with the primary key.
static TrashEntry	getEntry(String className, long classPK) Returns the entry with the entity class name and primary key.
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static TrashEntryLocalService	getService()
static List<TrashEntry>	getTrashEntries(int start, int end) Returns a range of all the trash entries.
static int	getTrashEntriesCount() Returns the number of trash entries.
static TrashEntry	getTrashEntry(long entryId) Returns the trash entry with the primary key.
static Hits	search(long companyId, long groupId, long userId, String keywords, int start, int end, Sort sort)
static BaseModelSearchResult<TrashEntry>	searchTrashEntries(long companyId, long groupId, long userId, String keywords, int start, int end, Sort sort)
static 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

TrashEntryLocalServiceUtil

public TrashEntryLocalServiceUtil()

Method Detail

addTrashEntry

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

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

public static void checkEntries()
                         throws PortalException

Throws:

PortalException

createTrashEntry

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

public static void deleteEntries(long groupId)

deleteEntries

public static void deleteEntries(long groupId,
                                 boolean deleteTrashedModels)

deleteEntry

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

public static TrashEntry deleteEntry(TrashEntry trashEntry)

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteTrashEntry

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

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

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

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

public static TrashEntry fetchTrashEntry(long entryId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getEntries

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

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

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

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

getEntriesCount

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

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

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getTrashEntries

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

public static int getTrashEntriesCount()

Returns the number of trash entries.

Returns:

the number of trash entries

getTrashEntry

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

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

searchTrashEntries

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

updateTrashEntry

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

getService

public static TrashEntryLocalService getService()