com.liferay.trash.service

Class TrashVersionLocalServiceUtil

java.lang.Object

com.liferay.trash.service.TrashVersionLocalServiceUtil

public class TrashVersionLocalServiceUtil
extends java.lang.Object

Provides the local service utility for TrashVersion. This utility wraps com.liferay.trash.service.impl.TrashVersionLocalServiceImpl and is an 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.

See Also:

TrashVersionLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
TrashVersionLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static TrashVersion	addTrashVersion(long trashEntryId, java.lang.String className, long classPK, int status, com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties)
static TrashVersion	addTrashVersion(TrashVersion trashVersion) Adds the trash version to the database.
static com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static TrashVersion	createTrashVersion(long versionId) Creates a new trash version with the primary key.
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
static TrashVersion	deleteTrashVersion(long versionId) Deletes the trash version with the primary key from the database.
static TrashVersion	deleteTrashVersion(java.lang.String className, long classPK)
static TrashVersion	deleteTrashVersion(TrashVersion trashVersion) Deletes the trash version from the database.
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.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.
static <T> java.util.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.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static 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.
static TrashVersion	fetchTrashVersion(long versionId)
static TrashVersion	fetchVersion(java.lang.String className, long classPK)
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static TrashVersionLocalService	getService()
static TrashVersion	getTrashVersion(long versionId) Returns the trash version with the primary key.
static java.util.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 java.util.List<TrashVersion>	getVersions(long entryId)
static java.util.List<TrashVersion>	getVersions(long entryId, java.lang.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 java.lang.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,
                                           java.lang.String className,
                                           long classPK,
                                           int status,
                                           com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties)

addTrashVersion

public static TrashVersion addTrashVersion(TrashVersion trashVersion)

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

Important: Inspect TrashVersionLocalServiceImpl 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:

trashVersion - the trash version

Returns:

the trash version that was added

createPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

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 com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteTrashVersion

public static TrashVersion deleteTrashVersion(long versionId)
                                       throws com.liferay.portal.kernel.exception.PortalException

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

Important: Inspect TrashVersionLocalServiceImpl 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:

versionId - the primary key of the trash version

Returns:

the trash version that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a trash version with the primary key could not be found

deleteTrashVersion

public static TrashVersion deleteTrashVersion(java.lang.String className,
                                              long classPK)

deleteTrashVersion

public static TrashVersion deleteTrashVersion(TrashVersion trashVersion)

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

Important: Inspect TrashVersionLocalServiceImpl 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:

trashVersion - the trash version

Returns:

the trash version that was removed

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dslQueryCount

public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.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

public static <T> java.util.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.TrashVersionModelImpl.

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> java.util.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.TrashVersionModelImpl.

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

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

fetchTrashVersion

public static TrashVersion fetchTrashVersion(long versionId)

fetchVersion

public static TrashVersion fetchVersion(java.lang.String className,
                                        long classPK)

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getTrashVersion

public static TrashVersion getTrashVersion(long versionId)
                                    throws com.liferay.portal.kernel.exception.PortalException

Returns the trash version with the primary key.

Parameters:

versionId - the primary key of the trash version

Returns:

the trash version

Throws:

com.liferay.portal.kernel.exception.PortalException - if a trash version with the primary key could not be found

getTrashVersions

public static java.util.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 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.TrashVersionModelImpl.

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 java.util.List<TrashVersion> getVersions(long entryId)

getVersions

public static java.util.List<TrashVersion> getVersions(long entryId,
                                                       java.lang.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.

Important: Inspect TrashVersionLocalServiceImpl 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:

trashVersion - the trash version

Returns:

the trash version that was updated

getService

public static TrashVersionLocalService getService()