com.liferay.portlet.trash.service.TrashEntryLocalService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portlet.trash.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.service.BaseLocalService;
import com.liferay.portal.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.
*
* @author Brian Wing Shun Chan
* @see TrashEntryLocalServiceUtil
* @see com.liferay.portlet.trash.service.base.TrashEntryLocalServiceBaseImpl
* @see com.liferay.portlet.trash.service.impl.TrashEntryLocalServiceImpl
* @generated
*/
@ProviderType
@Transactional(isolation = Isolation.PORTAL, rollbackFor = {
PortalException.class, SystemException.class})
public interface TrashEntryLocalService extends BaseLocalService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link TrashEntryLocalServiceUtil} to access the trash entry local service. Add custom service methods to {@link com.liferay.portlet.trash.service.impl.TrashEntryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the trash entry to the database. Also notifies the appropriate model listeners.
*
* @param trashEntry the trash entry
* @return the trash entry that was added
* @throws SystemException if a system exception occurred
*/
public com.liferay.portlet.trash.model.TrashEntry addTrashEntry(
com.liferay.portlet.trash.model.TrashEntry trashEntry)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Creates a new trash entry with the primary key. Does not add the trash entry to the database.
*
* @param entryId the primary key for the new trash entry
* @return the new trash entry
*/
public com.liferay.portlet.trash.model.TrashEntry createTrashEntry(
long entryId);
/**
* Deletes the trash entry with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param entryId the primary key of the trash entry
* @return the trash entry that was removed
* @throws PortalException if a trash entry with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portlet.trash.model.TrashEntry deleteTrashEntry(
long entryId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Deletes the trash entry from the database. Also notifies the appropriate model listeners.
*
* @param trashEntry the trash entry
* @return the trash entry that was removed
* @throws SystemException if a system exception occurred
*/
public com.liferay.portlet.trash.model.TrashEntry deleteTrashEntry(
com.liferay.portlet.trash.model.TrashEntry trashEntry)
throws com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.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 {@link 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 and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.trash.model.impl.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) throws com.liferay.portal.kernel.exception.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 {@link 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 and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.trash.model.impl.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portlet.trash.model.TrashEntry fetchTrashEntry(
long entryId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the trash entry with the primary key.
*
* @param entryId the primary key of the trash entry
* @return the trash entry
* @throws PortalException if a trash entry with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portlet.trash.model.TrashEntry getTrashEntry(
long entryId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.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 {@link 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 and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.trash.model.impl.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.
*
*
* @param start the lower bound of the range of trash entries
* @param end the upper bound of the range of trash entries (not inclusive)
* @return the range of trash entries
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getTrashEntries(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of trash entries.
*
* @return the number of trash entries
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getTrashEntriesCount()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Updates the trash entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param trashEntry the trash entry
* @return the trash entry that was updated
* @throws SystemException if a system exception occurred
*/
public com.liferay.portlet.trash.model.TrashEntry updateTrashEntry(
com.liferay.portlet.trash.model.TrashEntry trashEntry)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the Spring bean ID for this bean.
*
* @return the Spring bean ID for this bean
*/
public java.lang.String getBeanIdentifier();
/**
* Sets the Spring bean ID for this bean.
*
* @param beanIdentifier the Spring bean ID for this bean
*/
public void setBeanIdentifier(java.lang.String beanIdentifier);
/**
* Moves an entry to trash.
*
* @param userId the primary key of the user removing the entity
* @param groupId the primary key of the entry's group
* @param className the class name of the entity
* @param classPK the primary key of the entity
* @param status the status of the entity prior to being moved to trash
* @param statusOVPs the primary keys and statuses of any of the entry's
versions (e.g., {@link
com.liferay.portlet.documentlibrary.model.DLFileVersion})
* @param typeSettingsProperties the type settings properties
* @return the trashEntry
* @throws PortalException if a user with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portlet.trash.model.TrashEntry addTrashEntry(
long userId, long groupId, java.lang.String className, long classPK,
java.lang.String classUuid, java.lang.String referrerClassName,
int status,
java.util.List> statusOVPs,
com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void checkEntries()
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Deletes the trash entry with the primary key.
*
* @param entryId the primary key of the trash entry
* @return the trash entry with the primary key
* @throws PortalException if a trash entry with the primary key could not
be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portlet.trash.model.TrashEntry deleteEntry(long entryId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Deletes the trash entry with the entity class name and primary key.
*
* @param className the class name of entity
* @param classPK the primary key of the entry
* @return 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
* @throws SystemException if a system exception occurred
*/
public com.liferay.portlet.trash.model.TrashEntry deleteEntry(
java.lang.String className, long classPK)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portlet.trash.model.TrashEntry deleteEntry(
com.liferay.portlet.trash.model.TrashEntry trashEntry)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the trash entry with the primary key.
*
* @param entryId the primary key of the entry
* @return the trash entry with the primary key
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portlet.trash.model.TrashEntry fetchEntry(long entryId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the trash entry with the entity class name and primary key.
*
* @param className the class name of the entity
* @param classPK the primary key of the entity
* @return the trash entry with the entity class name and primary key
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portlet.trash.model.TrashEntry fetchEntry(
java.lang.String className, long classPK)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the trash entries with the matching group ID.
*
* @param groupId the primary key of the group
* @return the trash entries with the group ID
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getEntries(
long groupId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns a range of all the trash entries matching the group ID.
*
* @param groupId the primary key of the group
* @param start the lower bound of the range of trash entries to return
* @param end the upper bound of the range of trash entries to return (not
inclusive)
* @return the range of matching trash entries
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getEntries(
long groupId, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns a range of all the trash entries matching the group ID.
*
* @param groupId the primary key of the group
* @param start the lower bound of the range of trash entries to return
* @param end the upper bound of the range of trash entries to return (not
inclusive)
* @param obc the comparator to order the trash entries (optionally
null)
* @return the range of matching trash entries ordered by comparator
obc
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getEntries(
long groupId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator obc)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getEntries(
long groupId, java.lang.String className)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of trash entries with the group ID.
*
* @param groupId the primary key of the group
* @return the number of matching trash entries
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getEntriesCount(long groupId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the trash entry with the primary key.
*
* @param entryId the primary key of the trash entry
* @return the trash entry with the primary key
* @throws PortalException if a trash entry with the primary key could not
be found
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portlet.trash.model.TrashEntry getEntry(long entryId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the entry with the entity class name and primary key.
*
* @param className the class name of the entity
* @param classPK the primary key of the entity
* @return 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
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portlet.trash.model.TrashEntry getEntry(
java.lang.String className, long classPK)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.kernel.search.Hits search(long companyId,
long groupId, long userId, java.lang.String keywords, int start,
int end, com.liferay.portal.kernel.search.Sort sort)
throws com.liferay.portal.kernel.exception.SystemException;
}