Interface TrashEntryLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<TrashEntry>, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
TrashEntryLocalServiceWrapper

@CTAware @ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface TrashEntryLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<TrashEntry>, com.liferay.portal.kernel.service.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.
See Also:
Generated:
  • Method Details

    • addTrashEntry

      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.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)
      typeSettingsUnicodeProperties - the type settings properties
      Returns:
      the trashEntry
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addTrashEntry

      @Indexable(type=REINDEX) TrashEntry addTrashEntry(TrashEntry trashEntry)
      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

      void checkEntries() throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createPersistedModel

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.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

      com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteTrashEntry

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

      @Indexable(type=DELETE) TrashEntry deleteTrashEntry(TrashEntry trashEntry)
      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

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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(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 - 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.trash.model.impl.TrashEntryModelImpl.

      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(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 - 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.trash.model.impl.TrashEntryModelImpl.

      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(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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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 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) com.liferay.portal.kernel.dao.orm.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, 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 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)
      orderByComparator - the comparator to order the trash entries (optionally null)
      Returns:
      the range of matching trash entries ordered by comparator orderByComparator
    • 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 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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.trash.model.impl.TrashEntryModelImpl.

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

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

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

      @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.

      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
    • getCTPersistence

      @Transactional(enabled=false) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<TrashEntry> getCTPersistence()
      Specified by:
      getCTPersistence in interface com.liferay.portal.kernel.service.change.tracking.CTService<TrashEntry>
    • getModelClass

      @Transactional(enabled=false) Class<TrashEntry> getModelClass()
      Specified by:
      getModelClass in interface com.liferay.portal.kernel.service.change.tracking.CTService<TrashEntry>
    • updateWithUnsafeFunction

      @Transactional(rollbackFor=java.lang.Throwable.class) <R, E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<TrashEntry>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface com.liferay.portal.kernel.service.change.tracking.CTService<TrashEntry>
      Throws:
      E extends Throwable