com.liferay.trash.kernel.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.

Author:

Brian Wing Shun Chan

See Also:

TrashVersionLocalServiceUtil, TrashVersionLocalServiceBaseImpl, TrashVersionLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
TrashVersion	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.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
TrashVersion	deleteTrashVersion(long versionId) Deletes the trash version with the primary key from the database.
TrashVersion	deleteTrashVersion(String className, long classPK)
TrashVersion	deleteTrashVersion(TrashVersion trashVersion) Deletes the trash version from the database.
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<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.
<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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
TrashVersion	fetchTrashVersion(long versionId)
TrashVersion	fetchVersion(long entryId, String className, long classPK) Deprecated. As of Wilberforce (7.0.x), replaced by fetchVersion(String, long)
TrashVersion	fetchVersion(String className, long classPK)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
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)
TrashVersion	updateTrashVersion(TrashVersion trashVersion) Updates the trash version in the database or adds it if it does not yet exist.

Method Detail

addTrashVersion

TrashVersion addTrashVersion(long trashEntryId,
                             String className,
                             long classPK,
                             int status,
                             UnicodeProperties typeSettingsProperties)

addTrashVersion

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

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

createTrashVersion

@Transactional(enabled=false)
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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteTrashVersion

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

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

deleteTrashVersion

TrashVersion deleteTrashVersion(String className,
                                long classPK)

deleteTrashVersion

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

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

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

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

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

dynamicQuery

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

dynamicQueryCount

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

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

fetchTrashVersion

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

fetchVersion

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

Deprecated. As of Wilberforce (7.0.x), replaced by fetchVersion(String, long)

fetchVersion

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

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getTrashVersion

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

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

getTrashVersions

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

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

getTrashVersionsCount

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

Returns the number of trash versions.

Returns:

the number of trash versions

getVersions

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

getVersions

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

updateTrashVersion

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

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