com.liferay.portlet.trash.service
Interface TrashVersionLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

TrashVersionLocalServiceWrapper

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

Provides the local service interface for TrashVersion. 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:

TrashVersionLocalServiceUtil, com.liferay.portlet.trash.service.base.TrashVersionLocalServiceBaseImpl, com.liferay.portlet.trash.service.impl.TrashVersionLocalServiceImpl

Method Summary

void	addTrashVersion(long trashEntryId, String className, long classPK, int status, UnicodeProperties typeSettingsProperties)
TrashVersion	addTrashVersion(TrashVersion trashVersion) Adds the trash version to the database.
TrashVersion	createTrashVersion(long versionId) Creates a new trash version with the primary key.
TrashVersion	deleteTrashVersion(long versionId) Deletes the trash version with the primary key from the database.
TrashVersion	deleteTrashVersion(long entryId, String className, long classPK)
TrashVersion	deleteTrashVersion(TrashVersion trashVersion) Deletes the trash version from the database.
DynamicQuery	dynamicQuery()
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
TrashVersion	fetchTrashVersion(long versionId)
TrashVersion	fetchVersion(long entryId, String className, long classPK)
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
TrashVersion	getTrashVersion(long versionId) Returns the trash version with the primary key.
List<TrashVersion>	getTrashVersions(int start, int end) Returns a range of all the trash versions.
int	getTrashVersionsCount() Returns the number of trash versions.
List<TrashVersion>	getVersions(long entryId)
List<TrashVersion>	getVersions(long entryId, String className)
List<TrashVersion>	getVersions(String className, long classPK) Returns all the trash versions associated with the trash entry.
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
TrashVersion	updateTrashVersion(TrashVersion trashVersion) Updates the trash version in the database or adds it if it does not yet exist.

Method Detail

addTrashVersion

@Indexable(type=REINDEX)
TrashVersion addTrashVersion(TrashVersion trashVersion)
                             throws SystemException

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

Parameters:

trashVersion - the trash version

Returns:

the trash version that was added

Throws:

SystemException - if a system exception occurred

createTrashVersion

TrashVersion createTrashVersion(long versionId)

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

Parameters:

versionId - the primary key for the new trash version

Returns:

the new trash version

deleteTrashVersion

@Indexable(type=DELETE)
TrashVersion deleteTrashVersion(long versionId)
                                throws PortalException,
                                       SystemException

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

Parameters:

versionId - the primary key of the trash version

Returns:

the trash version that was removed

Throws:

PortalException - if a trash version with the primary key could not be found

SystemException - if a system exception occurred

deleteTrashVersion

@Indexable(type=DELETE)
TrashVersion deleteTrashVersion(TrashVersion trashVersion)
                                throws SystemException

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

Parameters:

trashVersion - the trash version

Returns:

the trash version that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws 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 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 TrashVersionModelImpl. 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

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws 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 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 TrashVersionModelImpl. 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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchTrashVersion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
TrashVersion fetchTrashVersion(long versionId)
                               throws SystemException

Throws:

SystemException

getTrashVersion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
TrashVersion getTrashVersion(long versionId)
                             throws PortalException,
                                    SystemException

Returns the trash version with the primary key.

Parameters:

versionId - the primary key of the trash version

Returns:

the trash version

Throws:

PortalException - if a trash version with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getTrashVersions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<TrashVersion> getTrashVersions(int start,
                                                                             int end)
                                    throws SystemException

Returns a range of all the trash versions.

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 TrashVersionModelImpl. 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 versions

end - the upper bound of the range of trash versions (not inclusive)

Returns:

the range of trash versions

Throws:

SystemException - if a system exception occurred

getTrashVersionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getTrashVersionsCount()
                          throws SystemException

Returns the number of trash versions.

Returns:

the number of trash versions

Throws:

SystemException - if a system exception occurred

updateTrashVersion

@Indexable(type=REINDEX)
TrashVersion updateTrashVersion(TrashVersion trashVersion)
                                throws SystemException

Updates the trash version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

trashVersion - the trash version

Returns:

the trash version that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addTrashVersion

void addTrashVersion(long trashEntryId,
                     String className,
                     long classPK,
                     int status,
                     UnicodeProperties typeSettingsProperties)
                     throws SystemException

Throws:

SystemException

deleteTrashVersion

TrashVersion deleteTrashVersion(long entryId,
                                String className,
                                long classPK)
                                throws SystemException

Throws:

SystemException

fetchVersion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
TrashVersion fetchVersion(long entryId,
                                                                   String className,
                                                                   long classPK)
                          throws SystemException

Throws:

SystemException

getVersions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<TrashVersion> getVersions(long entryId)
                               throws SystemException

Throws:

SystemException

getVersions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<TrashVersion> getVersions(long entryId,
                                                                        String className)
                               throws SystemException

Throws:

SystemException

getVersions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<TrashVersion> getVersions(String className,
                                                                        long classPK)
                               throws SystemException

Returns all the trash versions associated with the trash entry.

Parameters:

className - the class name of the trash entity

classPK - the primary key of the trash entity

Returns:

all the trash versions associated with the trash entry

Throws:

SystemException - if a system exception occurred