com.liferay.trash.kernel.service

Class TrashVersionLocalServiceUtil

Object

com.liferay.trash.kernel.service.TrashVersionLocalServiceUtil

@ProviderType
public class TrashVersionLocalServiceUtil
extends Object

Provides the local service utility for TrashVersion. This utility wraps TrashVersionLocalServiceImpl and is the primary 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.

Author:

Brian Wing Shun Chan

See Also:

TrashVersionLocalService, TrashVersionLocalServiceBaseImpl, TrashVersionLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
TrashVersionLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static TrashVersion	addTrashVersion(long trashEntryId, String className, long classPK, int status, UnicodeProperties typeSettingsProperties)
static TrashVersion	addTrashVersion(TrashVersion trashVersion) Adds the trash version to the database.
static TrashVersion	createTrashVersion(long versionId) Creates a new trash version with the primary key.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static TrashVersion	deleteTrashVersion(long versionId) Deletes the trash version with the primary key from the database.
static TrashVersion	deleteTrashVersion(String className, long classPK)
static TrashVersion	deleteTrashVersion(TrashVersion trashVersion) Deletes the trash version from the database.
static DynamicQuery	dynamicQuery()
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <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.
static <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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static TrashVersion	fetchTrashVersion(long versionId)
static TrashVersion	fetchVersion(long entryId, String className, long classPK) Deprecated. As of Wilberforce (7.0.x), replaced by fetchVersion(String, long)
static TrashVersion	fetchVersion(String className, long classPK)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static TrashVersionLocalService	getService()
static TrashVersion	getTrashVersion(long versionId) Returns the trash version with the primary key.
static List<TrashVersion>	getTrashVersions(int start, int end) Returns a range of all the trash versions.
static int	getTrashVersionsCount() Returns the number of trash versions.
static List<TrashVersion>	getVersions(long entryId)
static List<TrashVersion>	getVersions(long entryId, String className)
static TrashVersion	updateTrashVersion(TrashVersion trashVersion) Updates the trash version in the database or adds it if it does not yet exist.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TrashVersionLocalServiceUtil

public TrashVersionLocalServiceUtil()

Method Detail

addTrashVersion

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

addTrashVersion

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

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

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteTrashVersion

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

public static TrashVersion deleteTrashVersion(String className,
                                              long classPK)

deleteTrashVersion

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

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

public static TrashVersion fetchTrashVersion(long versionId)

fetchVersion

@Deprecated
public static TrashVersion fetchVersion(long entryId,
                                                    String className,
                                                    long classPK)

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

fetchVersion

public static TrashVersion fetchVersion(String className,
                                        long classPK)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getTrashVersion

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

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

public static int getTrashVersionsCount()

Returns the number of trash versions.

Returns:

the number of trash versions

getVersions

public static List<TrashVersion> getVersions(long entryId)

getVersions

public static List<TrashVersion> getVersions(long entryId,
                                             String className)

updateTrashVersion

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

getService

public static TrashVersionLocalService getService()