Class TrashEntryLocalServiceUtil
com.liferay.trash.service.impl.TrashEntryLocalServiceImpl and
is an 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.- See Also:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic TrashEntryaddTrashEntry(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 typeSettingsUnicodeProperties) Moves an entry to trash.static TrashEntryaddTrashEntry(TrashEntry trashEntry) Adds the trash entry to the database.static voidstatic com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static TrashEntrycreateTrashEntry(long entryId) Creates a new trash entry with the primary key.static voiddeleteEntries(long groupId) static voiddeleteEntries(long groupId, boolean deleteTrashedModels) static TrashEntrydeleteEntry(long entryId) Deletes the trash entry with the primary key.static TrashEntrydeleteEntry(TrashEntry trashEntry) static TrashEntrydeleteEntry(String className, long classPK) Deletes the trash entry with the entity class name and primary key.static com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) static TrashEntrydeleteTrashEntry(long entryId) Deletes the trash entry with the primary key from the database.static TrashEntrydeleteTrashEntry(TrashEntry trashEntry) Deletes the trash entry from the database.static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuerystatic <T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.static longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.static TrashEntryfetchEntry(long entryId) Returns the trash entry with the primary key.static TrashEntryfetchEntry(String className, long classPK) Returns the trash entry with the entity class name and primary key.static TrashEntryfetchTrashEntry(long entryId) static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic 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, com.liferay.portal.kernel.util.OrderByComparator<TrashEntry> orderByComparator) Returns a range of all the trash entries matching the group ID.static List<TrashEntry>getEntries(long groupId, String className) static intgetEntriesCount(long groupId) Returns the number of trash entries with the group ID.static TrashEntrygetEntry(long entryId) Returns the trash entry with the primary key.static TrashEntryReturns the entry with the entity class name and primary key.static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerystatic StringReturns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) static TrashEntryLocalServicestatic List<TrashEntry>getTrashEntries(int start, int end) Returns a range of all the trash entries.static intReturns the number of trash entries.static TrashEntrygetTrashEntry(long entryId) Returns the trash entry with the primary key.static com.liferay.portal.kernel.search.Hitssearch(long companyId, long groupId, long userId, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort) static com.liferay.portal.kernel.search.BaseModelSearchResult<TrashEntry>searchTrashEntries(long companyId, long groupId, long userId, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort) static TrashEntryupdateTrashEntry(TrashEntry trashEntry) Updates the trash entry in the database or adds it if it does not yet exist.
-
Constructor Details
-
TrashEntryLocalServiceUtil
public TrashEntryLocalServiceUtil()
-
-
Method Details
-
addTrashEntry
public static 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 typeSettingsUnicodeProperties) throws com.liferay.portal.kernel.exception.PortalExceptionMoves an entry to trash.- Parameters:
userId- the primary key of the user removing the entitygroupId- the primary key of the entry's groupclassName- the class name of the entityclassPK- the primary key of the entityclassUuid- the UUID of the entity's classreferrerClassName- the referrer class name used to add a deletionSystemEventstatus- the status of the entity prior to being moved to trashstatusOVPs- the primary keys and statuses of any of the entry's versions (e.g.,com.liferay.portlet.documentlibrary.model.DLFileVersion)typeSettingsUnicodeProperties- the type settings properties- Returns:
- the trashEntry
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addTrashEntry
Adds the trash entry to the database. Also notifies the appropriate model listeners.Important: Inspect TrashEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
trashEntry- the trash entry- Returns:
- the trash entry that was added
-
checkEntries
public static void checkEntries() throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
createPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createTrashEntry
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
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
Deletes the trash entry with the entity class name and primary key.- Parameters:
className- the class name of entityclassPK- the primary key of the entry- Returns:
- the trash entry with the entity class name and primary key
-
deleteEntry
-
deletePersistedModel
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteTrashEntry
public static TrashEntry deleteTrashEntry(long entryId) throws com.liferay.portal.kernel.exception.PortalException Deletes the trash entry with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect TrashEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
entryId- the primary key of the trash entry- Returns:
- the trash entry that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a trash entry with the primary key could not be found
-
deleteTrashEntry
Deletes the trash entry from the database. Also notifies the appropriate model listeners.Important: Inspect TrashEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
trashEntry- the trash entry- Returns:
- the trash entry that was removed
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
public static com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.trash.model.impl.TrashEntryModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.trash.model.impl.TrashEntryModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery- the dynamic queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchEntry
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
Returns the trash entry with the entity class name and primary key.- Parameters:
className- the class name of the entityclassPK- the primary key of the entity- Returns:
- the trash entry with the entity class name and primary key
-
fetchTrashEntry
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getEntries
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
Returns a range of all the trash entries matching the group ID.- Parameters:
groupId- the primary key of the groupstart- the lower bound of the range of trash entries to returnend- 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, com.liferay.portal.kernel.util.OrderByComparator<TrashEntry> orderByComparator) Returns a range of all the trash entries matching the group ID.- Parameters:
groupId- the primary key of the groupstart- the lower bound of the range of trash entries to returnend- the upper bound of the range of trash entries to return (not inclusive)orderByComparator- the comparator to order the trash entries (optionallynull)- Returns:
- the range of matching trash entries ordered by comparator
orderByComparator
-
getEntries
-
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 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 static 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 entityclassPK- 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
-
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getTrashEntries
Returns a range of all the trash entries.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.trash.model.impl.TrashEntryModelImpl.- Parameters:
start- the lower bound of the range of trash entriesend- 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 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
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a trash entry with the primary key could not be found
-
search
public static 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 static com.liferay.portal.kernel.search.BaseModelSearchResult<TrashEntry> searchTrashEntries(long companyId, long groupId, long userId, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort) -
updateTrashEntry
Updates the trash entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect TrashEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
trashEntry- the trash entry- Returns:
- the trash entry that was updated
-
getService
-