com.liferay.document.library.kernel.service

Class DLFileRankLocalServiceUtil

Object

com.liferay.document.library.kernel.service.DLFileRankLocalServiceUtil

@ProviderType
public class DLFileRankLocalServiceUtil
extends Object

Provides the local service utility for DLFileRank. This utility wraps DLFileRankLocalServiceImpl 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:

DLFileRankLocalService, DLFileRankLocalServiceBaseImpl, DLFileRankLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
DLFileRankLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static DLFileRank	addDLFileRank(DLFileRank dlFileRank) Adds the document library file rank to the database.
static DLFileRank	addFileRank(long groupId, long companyId, long userId, long fileEntryId, ServiceContext serviceContext)
static void	checkFileRanks()
static DLFileRank	createDLFileRank(long fileRankId) Creates a new document library file rank with the primary key.
static DLFileRank	deleteDLFileRank(DLFileRank dlFileRank) Deletes the document library file rank from the database.
static DLFileRank	deleteDLFileRank(long fileRankId) Deletes the document library file rank with the primary key from the database.
static void	deleteFileRank(DLFileRank dlFileRank)
static void	deleteFileRank(long fileRankId)
static void	deleteFileRanksByFileEntryId(long fileEntryId)
static void	deleteFileRanksByUserId(long userId)
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static void	disableFileRanks(long fileEntryId)
static void	disableFileRanksByFolderId(long folderId)
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 void	enableFileRanks(long fileEntryId)
static void	enableFileRanksByFolderId(long folderId)
static DLFileRank	fetchDLFileRank(long fileRankId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static DLFileRank	getDLFileRank(long fileRankId) Returns the document library file rank with the primary key.
static List<DLFileRank>	getDLFileRanks(int start, int end) Returns a range of all the document library file ranks.
static int	getDLFileRanksCount() Returns the number of document library file ranks.
static List<DLFileRank>	getFileRanks(long groupId, long userId)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static DLFileRankLocalService	getService()
static DLFileRank	updateDLFileRank(DLFileRank dlFileRank) Updates the document library file rank in the database or adds it if it does not yet exist.
static DLFileRank	updateFileRank(long groupId, long companyId, long userId, long fileEntryId, ServiceContext serviceContext)

Methods inherited from class Object

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

Constructor Detail

DLFileRankLocalServiceUtil

public DLFileRankLocalServiceUtil()

Method Detail

addDLFileRank

public static DLFileRank addDLFileRank(DLFileRank dlFileRank)

Adds the document library file rank to the database. Also notifies the appropriate model listeners.

Parameters:

dlFileRank - the document library file rank

Returns:

the document library file rank that was added

addFileRank

public static DLFileRank addFileRank(long groupId,
                                     long companyId,
                                     long userId,
                                     long fileEntryId,
                                     ServiceContext serviceContext)

checkFileRanks

public static void checkFileRanks()

createDLFileRank

public static DLFileRank createDLFileRank(long fileRankId)

Creates a new document library file rank with the primary key. Does not add the document library file rank to the database.

Parameters:

fileRankId - the primary key for the new document library file rank

Returns:

the new document library file rank

deleteDLFileRank

public static DLFileRank deleteDLFileRank(DLFileRank dlFileRank)

Deletes the document library file rank from the database. Also notifies the appropriate model listeners.

Parameters:

dlFileRank - the document library file rank

Returns:

the document library file rank that was removed

deleteDLFileRank

public static DLFileRank deleteDLFileRank(long fileRankId)
                                   throws PortalException

Deletes the document library file rank with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

fileRankId - the primary key of the document library file rank

Returns:

the document library file rank that was removed

Throws:

PortalException - if a document library file rank with the primary key could not be found

deleteFileRank

public static void deleteFileRank(DLFileRank dlFileRank)

deleteFileRank

public static void deleteFileRank(long fileRankId)
                           throws PortalException

Throws:

PortalException

deleteFileRanksByFileEntryId

public static void deleteFileRanksByFileEntryId(long fileEntryId)

deleteFileRanksByUserId

public static void deleteFileRanksByUserId(long userId)

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

disableFileRanks

public static void disableFileRanks(long fileEntryId)

disableFileRanksByFolderId

public static void disableFileRanksByFolderId(long folderId)
                                       throws PortalException

Throws:

PortalException

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 DLFileRankModelImpl. 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 DLFileRankModelImpl. 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

enableFileRanks

public static void enableFileRanks(long fileEntryId)

enableFileRanksByFolderId

public static void enableFileRanksByFolderId(long folderId)
                                      throws PortalException

Throws:

PortalException

fetchDLFileRank

public static DLFileRank fetchDLFileRank(long fileRankId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getDLFileRank

public static DLFileRank getDLFileRank(long fileRankId)
                                throws PortalException

Returns the document library file rank with the primary key.

Parameters:

fileRankId - the primary key of the document library file rank

Returns:

the document library file rank

Throws:

PortalException - if a document library file rank with the primary key could not be found

getDLFileRanks

public static List<DLFileRank> getDLFileRanks(int start,
                                              int end)

Returns a range of all the document library file ranks.

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 DLFileRankModelImpl. 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 document library file ranks

end - the upper bound of the range of document library file ranks (not inclusive)

Returns:

the range of document library file ranks

getDLFileRanksCount

public static int getDLFileRanksCount()

Returns the number of document library file ranks.

Returns:

the number of document library file ranks

getFileRanks

public static List<DLFileRank> getFileRanks(long groupId,
                                            long userId)

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

updateDLFileRank

public static DLFileRank updateDLFileRank(DLFileRank dlFileRank)

Updates the document library file rank in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

dlFileRank - the document library file rank

Returns:

the document library file rank that was updated

updateFileRank

public static DLFileRank updateFileRank(long groupId,
                                        long companyId,
                                        long userId,
                                        long fileEntryId,
                                        ServiceContext serviceContext)

getService

public static DLFileRankLocalService getService()