DLFileRankUtil

java.lang.Object
- com.liferay.portlet.documentlibrary.service.persistence.DLFileRankUtil

```
@ProviderType
public class DLFileRankUtil
extends java.lang.Object
```
The persistence utility for the document library file rank service. This utility wraps DLFileRankPersistenceImpl and provides direct access to the database for CRUD operations. This utility should only be used by the service layer, as it must operate within a transaction. Never access this utility in a JSP, controller, model, or other front-end class.
Caching information and settings can be found in portal.properties

Author:

Brian Wing Shun Chan

See Also:
DLFileRankPersistence, DLFileRankPersistenceImpl
Generated:

Constructor Summary

Constructors
Constructor and Description

DLFileRankUtil()

Constructors
Constructor and Description
`DLFileRankUtil()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`cacheResult(DLFileRank dlFileRank)` Caches the document library file rank in the entity cache if it is enabled.
`static void`	`cacheResult(java.util.List<DLFileRank> dlFileRanks)` Caches the document library file ranks in the entity cache if it is enabled.
`static void`	`clearCache()`
`static void`	`clearCache(DLFileRank dlFileRank)`
`static int`	`countAll()` Returns the number of document library file ranks.
`static int`	`countByC_U_F(long companyId, long userId, long fileEntryId)` Returns the number of document library file ranks where companyId = ? and userId = ? and fileEntryId = ?.
`static int`	`countByFileEntryId(long fileEntryId)` Returns the number of document library file ranks where fileEntryId = ?.
`static int`	`countByG_U_A(long groupId, long userId, boolean active)` Returns the number of document library file ranks where groupId = ? and userId = ? and active = ?.
`static int`	`countByG_U(long groupId, long userId)` Returns the number of document library file ranks where groupId = ? and userId = ?.
`static int`	`countByUserId(long userId)` Returns the number of document library file ranks where userId = ?.
`static long`	`countWithDynamicQuery(DynamicQuery dynamicQuery)`
`static DLFileRank`	`create(long fileRankId)` Creates a new document library file rank with the primary key.
`static DLFileRank`	`fetchByC_U_F(long companyId, long userId, long fileEntryId)` Returns the document library file rank where companyId = ? and userId = ? and fileEntryId = ? or returns `null` if it could not be found.
`static DLFileRank`	`fetchByC_U_F(long companyId, long userId, long fileEntryId, boolean retrieveFromCache)` Returns the document library file rank where companyId = ? and userId = ? and fileEntryId = ? or returns `null` if it could not be found, optionally using the finder cache.
`static DLFileRank`	`fetchByFileEntryId_First(long fileEntryId, OrderByComparator orderByComparator)` Returns the first document library file rank in the ordered set where fileEntryId = ?.
`static DLFileRank`	`fetchByFileEntryId_Last(long fileEntryId, OrderByComparator orderByComparator)` Returns the last document library file rank in the ordered set where fileEntryId = ?.
`static DLFileRank`	`fetchByG_U_A_First(long groupId, long userId, boolean active, OrderByComparator orderByComparator)` Returns the first document library file rank in the ordered set where groupId = ? and userId = ? and active = ?.
`static DLFileRank`	`fetchByG_U_A_Last(long groupId, long userId, boolean active, OrderByComparator orderByComparator)` Returns the last document library file rank in the ordered set where groupId = ? and userId = ? and active = ?.
`static DLFileRank`	`fetchByG_U_First(long groupId, long userId, OrderByComparator orderByComparator)` Returns the first document library file rank in the ordered set where groupId = ? and userId = ?.
`static DLFileRank`	`fetchByG_U_Last(long groupId, long userId, OrderByComparator orderByComparator)` Returns the last document library file rank in the ordered set where groupId = ? and userId = ?.
`static DLFileRank`	`fetchByPrimaryKey(long fileRankId)` Returns the document library file rank with the primary key or returns `null` if it could not be found.
`static DLFileRank`	`fetchByUserId_First(long userId, OrderByComparator orderByComparator)` Returns the first document library file rank in the ordered set where userId = ?.
`static DLFileRank`	`fetchByUserId_Last(long userId, OrderByComparator orderByComparator)` Returns the last document library file rank in the ordered set where userId = ?.
`static java.util.List<DLFileRank>`	`findAll()` Returns all the document library file ranks.
`static java.util.List<DLFileRank>`	`findAll(int start, int end)` Returns a range of all the document library file ranks.
`static java.util.List<DLFileRank>`	`findAll(int start, int end, OrderByComparator orderByComparator)` Returns an ordered range of all the document library file ranks.
`static DLFileRank`	`findByC_U_F(long companyId, long userId, long fileEntryId)` Returns the document library file rank where companyId = ? and userId = ? and fileEntryId = ? or throws a `NoSuchFileRankException` if it could not be found.
`static DLFileRank`	`findByFileEntryId_First(long fileEntryId, OrderByComparator orderByComparator)` Returns the first document library file rank in the ordered set where fileEntryId = ?.
`static DLFileRank`	`findByFileEntryId_Last(long fileEntryId, OrderByComparator orderByComparator)` Returns the last document library file rank in the ordered set where fileEntryId = ?.
`static DLFileRank[]`	`findByFileEntryId_PrevAndNext(long fileRankId, long fileEntryId, OrderByComparator orderByComparator)` Returns the document library file ranks before and after the current document library file rank in the ordered set where fileEntryId = ?.
`static java.util.List<DLFileRank>`	`findByFileEntryId(long fileEntryId)` Returns all the document library file ranks where fileEntryId = ?.
`static java.util.List<DLFileRank>`	`findByFileEntryId(long fileEntryId, int start, int end)` Returns a range of all the document library file ranks where fileEntryId = ?.
`static java.util.List<DLFileRank>`	`findByFileEntryId(long fileEntryId, int start, int end, OrderByComparator orderByComparator)` Returns an ordered range of all the document library file ranks where fileEntryId = ?.
`static DLFileRank`	`findByG_U_A_First(long groupId, long userId, boolean active, OrderByComparator orderByComparator)` Returns the first document library file rank in the ordered set where groupId = ? and userId = ? and active = ?.
`static DLFileRank`	`findByG_U_A_Last(long groupId, long userId, boolean active, OrderByComparator orderByComparator)` Returns the last document library file rank in the ordered set where groupId = ? and userId = ? and active = ?.
`static DLFileRank[]`	`findByG_U_A_PrevAndNext(long fileRankId, long groupId, long userId, boolean active, OrderByComparator orderByComparator)` Returns the document library file ranks before and after the current document library file rank in the ordered set where groupId = ? and userId = ? and active = ?.
`static java.util.List<DLFileRank>`	`findByG_U_A(long groupId, long userId, boolean active)` Returns all the document library file ranks where groupId = ? and userId = ? and active = ?.
`static java.util.List<DLFileRank>`	`findByG_U_A(long groupId, long userId, boolean active, int start, int end)` Returns a range of all the document library file ranks where groupId = ? and userId = ? and active = ?.
`static java.util.List<DLFileRank>`	`findByG_U_A(long groupId, long userId, boolean active, int start, int end, OrderByComparator orderByComparator)` Returns an ordered range of all the document library file ranks where groupId = ? and userId = ? and active = ?.
`static DLFileRank`	`findByG_U_First(long groupId, long userId, OrderByComparator orderByComparator)` Returns the first document library file rank in the ordered set where groupId = ? and userId = ?.
`static DLFileRank`	`findByG_U_Last(long groupId, long userId, OrderByComparator orderByComparator)` Returns the last document library file rank in the ordered set where groupId = ? and userId = ?.
`static DLFileRank[]`	`findByG_U_PrevAndNext(long fileRankId, long groupId, long userId, OrderByComparator orderByComparator)` Returns the document library file ranks before and after the current document library file rank in the ordered set where groupId = ? and userId = ?.
`static java.util.List<DLFileRank>`	`findByG_U(long groupId, long userId)` Returns all the document library file ranks where groupId = ? and userId = ?.
`static java.util.List<DLFileRank>`	`findByG_U(long groupId, long userId, int start, int end)` Returns a range of all the document library file ranks where groupId = ? and userId = ?.
`static java.util.List<DLFileRank>`	`findByG_U(long groupId, long userId, int start, int end, OrderByComparator orderByComparator)` Returns an ordered range of all the document library file ranks where groupId = ? and userId = ?.
`static DLFileRank`	`findByPrimaryKey(long fileRankId)` Returns the document library file rank with the primary key or throws a `NoSuchFileRankException` if it could not be found.
`static DLFileRank`	`findByUserId_First(long userId, OrderByComparator orderByComparator)` Returns the first document library file rank in the ordered set where userId = ?.
`static DLFileRank`	`findByUserId_Last(long userId, OrderByComparator orderByComparator)` Returns the last document library file rank in the ordered set where userId = ?.
`static DLFileRank[]`	`findByUserId_PrevAndNext(long fileRankId, long userId, OrderByComparator orderByComparator)` Returns the document library file ranks before and after the current document library file rank in the ordered set where userId = ?.
`static java.util.List<DLFileRank>`	`findByUserId(long userId)` Returns all the document library file ranks where userId = ?.
`static java.util.List<DLFileRank>`	`findByUserId(long userId, int start, int end)` Returns a range of all the document library file ranks where userId = ?.
`static java.util.List<DLFileRank>`	`findByUserId(long userId, int start, int end, OrderByComparator orderByComparator)` Returns an ordered range of all the document library file ranks where userId = ?.
`static java.util.List<DLFileRank>`	`findWithDynamicQuery(DynamicQuery dynamicQuery)`
`static java.util.List<DLFileRank>`	`findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end)`
`static java.util.List<DLFileRank>`	`findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)`
`static DLFileRankPersistence`	`getPersistence()`
`static DLFileRank`	`remove(long fileRankId)` Removes the document library file rank with the primary key from the database.
`static void`	`removeAll()` Removes all the document library file ranks from the database.
`static DLFileRank`	`removeByC_U_F(long companyId, long userId, long fileEntryId)` Removes the document library file rank where companyId = ? and userId = ? and fileEntryId = ? from the database.
`static void`	`removeByFileEntryId(long fileEntryId)` Removes all the document library file ranks where fileEntryId = ? from the database.
`static void`	`removeByG_U_A(long groupId, long userId, boolean active)` Removes all the document library file ranks where groupId = ? and userId = ? and active = ? from the database.
`static void`	`removeByG_U(long groupId, long userId)` Removes all the document library file ranks where groupId = ? and userId = ? from the database.
`static void`	`removeByUserId(long userId)` Removes all the document library file ranks where userId = ? from the database.
`void`	`setPersistence(DLFileRankPersistence persistence)` Deprecated. As of 6.2.0
`static DLFileRank`	`update(DLFileRank dlFileRank)`
`static DLFileRank`	`update(DLFileRank dlFileRank, ServiceContext serviceContext)`
`static DLFileRank`	`updateImpl(DLFileRank dlFileRank)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DLFileRankUtil
```
public DLFileRankUtil()
```
- Method Detail
  - clearCache
```
public static void clearCache()
```
    See Also:
    BasePersistence.clearCache()
  - clearCache
```
public static void clearCache(DLFileRank dlFileRank)
```
    See Also:
    BasePersistence.clearCache(com.liferay.portal.model.BaseModel)
  - countWithDynamicQuery
```
public static long countWithDynamicQuery(DynamicQuery dynamicQuery)
                                  throws SystemException
```
    Throws:
    
    SystemException
    See Also:
    BasePersistence.countWithDynamicQuery(DynamicQuery)
  - findWithDynamicQuery
```
public static java.util.List<DLFileRank> findWithDynamicQuery(DynamicQuery dynamicQuery)
                                                       throws SystemException
```
    Throws:
    
    SystemException
    See Also:
    BasePersistence.findWithDynamicQuery(DynamicQuery)
  - findWithDynamicQuery
```
public static java.util.List<DLFileRank> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                              int start,
                                              int end)
                                                       throws SystemException
```
    Throws:
    
    SystemException
    See Also:
    BasePersistence.findWithDynamicQuery(DynamicQuery, int, int)
  - findWithDynamicQuery
```
public static java.util.List<DLFileRank> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                              int start,
                                              int end,
                                              OrderByComparator orderByComparator)
                                                       throws SystemException
```
    Throws:
    
    SystemException
    See Also:
    BasePersistence.findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator)
  - update
```
public static DLFileRank update(DLFileRank dlFileRank)
                         throws SystemException
```
    Throws:
    
    SystemException
    See Also:
    BasePersistence.update(com.liferay.portal.model.BaseModel)
  - update
```
public static DLFileRank update(DLFileRank dlFileRank,
                ServiceContext serviceContext)
                         throws SystemException
```
    Throws:
    
    SystemException
    See Also:
    BasePersistence.update(com.liferay.portal.model.BaseModel, ServiceContext)
  - findByUserId
```
public static java.util.List<DLFileRank> findByUserId(long userId)
                                               throws SystemException
```
    Returns all the document library file ranks where userId = ?.
    
    Parameters:
    userId - the user ID
    
    Returns:
    the matching document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByUserId
```
public static java.util.List<DLFileRank> findByUserId(long userId,
                                      int start,
                                      int end)
                                               throws SystemException
```
    Returns a range of all the document library file ranks where userId = ?.
    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:
    userId - the user ID
    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 matching document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByUserId
```
public static java.util.List<DLFileRank> findByUserId(long userId,
                                      int start,
                                      int end,
                                      OrderByComparator orderByComparator)
                                               throws SystemException
```
    Returns an ordered range of all the document library file ranks where userId = ?.
    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:
    userId - the user ID
    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)
    orderByComparator - the comparator to order the results by (optionally null)
    
    Returns:
    the ordered range of matching document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByUserId_First
```
public static DLFileRank findByUserId_First(long userId,
                            OrderByComparator orderByComparator)
                                     throws SystemException,
                                            NoSuchFileRankException
```
    Returns the first document library file rank in the ordered set where userId = ?.
    
    Parameters:
    userId - the user ID
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the first matching document library file rank
    
    Throws:
    
    NoSuchFileRankException - if a matching document library file rank could not be found
    
    SystemException - if a system exception occurred
  - fetchByUserId_First
```
public static DLFileRank fetchByUserId_First(long userId,
                             OrderByComparator orderByComparator)
                                      throws SystemException
```
    Returns the first document library file rank in the ordered set where userId = ?.
    
    Parameters:
    userId - the user ID
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the first matching document library file rank, or null if a matching document library file rank could not be found
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByUserId_Last
```
public static DLFileRank findByUserId_Last(long userId,
                           OrderByComparator orderByComparator)
                                    throws SystemException,
                                           NoSuchFileRankException
```
    Returns the last document library file rank in the ordered set where userId = ?.
    
    Parameters:
    userId - the user ID
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the last matching document library file rank
    
    Throws:
    
    NoSuchFileRankException - if a matching document library file rank could not be found
    
    SystemException - if a system exception occurred
  - fetchByUserId_Last
```
public static DLFileRank fetchByUserId_Last(long userId,
                            OrderByComparator orderByComparator)
                                     throws SystemException
```
    Returns the last document library file rank in the ordered set where userId = ?.
    
    Parameters:
    userId - the user ID
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the last matching document library file rank, or null if a matching document library file rank could not be found
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByUserId_PrevAndNext
```
public static DLFileRank[] findByUserId_PrevAndNext(long fileRankId,
                                    long userId,
                                    OrderByComparator orderByComparator)
                                             throws SystemException,
                                                    NoSuchFileRankException
```
    Returns the document library file ranks before and after the current document library file rank in the ordered set where userId = ?.
    
    Parameters:
    fileRankId - the primary key of the current document library file rank
    userId - the user ID
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the previous, current, and next document library file rank
    
    Throws:
    
    NoSuchFileRankException - if a document library file rank with the primary key could not be found
    
    SystemException - if a system exception occurred
  - removeByUserId
```
public static void removeByUserId(long userId)
                           throws SystemException
```
    Removes all the document library file ranks where userId = ? from the database.
    
    Parameters:
    userId - the user ID
    
    Throws:
    
    SystemException - if a system exception occurred
  - countByUserId
```
public static int countByUserId(long userId)
                         throws SystemException
```
    Returns the number of document library file ranks where userId = ?.
    
    Parameters:
    userId - the user ID
    
    Returns:
    the number of matching document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByFileEntryId
```
public static java.util.List<DLFileRank> findByFileEntryId(long fileEntryId)
                                                    throws SystemException
```
    Returns all the document library file ranks where fileEntryId = ?.
    
    Parameters:
    fileEntryId - the file entry ID
    
    Returns:
    the matching document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByFileEntryId
```
public static java.util.List<DLFileRank> findByFileEntryId(long fileEntryId,
                                           int start,
                                           int end)
                                                    throws SystemException
```
    Returns a range of all the document library file ranks where fileEntryId = ?.
    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:
    fileEntryId - the file entry ID
    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 matching document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByFileEntryId
```
public static java.util.List<DLFileRank> findByFileEntryId(long fileEntryId,
                                           int start,
                                           int end,
                                           OrderByComparator orderByComparator)
                                                    throws SystemException
```
    Returns an ordered range of all the document library file ranks where fileEntryId = ?.
    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:
    fileEntryId - the file entry ID
    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)
    orderByComparator - the comparator to order the results by (optionally null)
    
    Returns:
    the ordered range of matching document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByFileEntryId_First
```
public static DLFileRank findByFileEntryId_First(long fileEntryId,
                                 OrderByComparator orderByComparator)
                                          throws SystemException,
                                                 NoSuchFileRankException
```
    Returns the first document library file rank in the ordered set where fileEntryId = ?.
    
    Parameters:
    fileEntryId - the file entry ID
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the first matching document library file rank
    
    Throws:
    
    NoSuchFileRankException - if a matching document library file rank could not be found
    
    SystemException - if a system exception occurred
  - fetchByFileEntryId_First
```
public static DLFileRank fetchByFileEntryId_First(long fileEntryId,
                                  OrderByComparator orderByComparator)
                                           throws SystemException
```
    Returns the first document library file rank in the ordered set where fileEntryId = ?.
    
    Parameters:
    fileEntryId - the file entry ID
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the first matching document library file rank, or null if a matching document library file rank could not be found
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByFileEntryId_Last
```
public static DLFileRank findByFileEntryId_Last(long fileEntryId,
                                OrderByComparator orderByComparator)
                                         throws SystemException,
                                                NoSuchFileRankException
```
    Returns the last document library file rank in the ordered set where fileEntryId = ?.
    
    Parameters:
    fileEntryId - the file entry ID
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the last matching document library file rank
    
    Throws:
    
    NoSuchFileRankException - if a matching document library file rank could not be found
    
    SystemException - if a system exception occurred
  - fetchByFileEntryId_Last
```
public static DLFileRank fetchByFileEntryId_Last(long fileEntryId,
                                 OrderByComparator orderByComparator)
                                          throws SystemException
```
    Returns the last document library file rank in the ordered set where fileEntryId = ?.
    
    Parameters:
    fileEntryId - the file entry ID
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the last matching document library file rank, or null if a matching document library file rank could not be found
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByFileEntryId_PrevAndNext
```
public static DLFileRank[] findByFileEntryId_PrevAndNext(long fileRankId,
                                         long fileEntryId,
                                         OrderByComparator orderByComparator)
                                                  throws SystemException,
                                                         NoSuchFileRankException
```
    Returns the document library file ranks before and after the current document library file rank in the ordered set where fileEntryId = ?.
    
    Parameters:
    fileRankId - the primary key of the current document library file rank
    fileEntryId - the file entry ID
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the previous, current, and next document library file rank
    
    Throws:
    
    NoSuchFileRankException - if a document library file rank with the primary key could not be found
    
    SystemException - if a system exception occurred
  - removeByFileEntryId
```
public static void removeByFileEntryId(long fileEntryId)
                                throws SystemException
```
    Removes all the document library file ranks where fileEntryId = ? from the database.
    
    Parameters:
    fileEntryId - the file entry ID
    
    Throws:
    
    SystemException - if a system exception occurred
  - countByFileEntryId
```
public static int countByFileEntryId(long fileEntryId)
                              throws SystemException
```
    Returns the number of document library file ranks where fileEntryId = ?.
    
    Parameters:
    fileEntryId - the file entry ID
    
    Returns:
    the number of matching document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByG_U
```
public static java.util.List<DLFileRank> findByG_U(long groupId,
                                   long userId)
                                            throws SystemException
```
    Returns all the document library file ranks where groupId = ? and userId = ?.
    
    Parameters:
    groupId - the group ID
    userId - the user ID
    
    Returns:
    the matching document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByG_U
```
public static java.util.List<DLFileRank> findByG_U(long groupId,
                                   long userId,
                                   int start,
                                   int end)
                                            throws SystemException
```
    Returns a range of all the document library file ranks where groupId = ? and userId = ?.
    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:
    groupId - the group ID
    userId - the user ID
    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 matching document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByG_U
```
public static java.util.List<DLFileRank> findByG_U(long groupId,
                                   long userId,
                                   int start,
                                   int end,
                                   OrderByComparator orderByComparator)
                                            throws SystemException
```
    Returns an ordered range of all the document library file ranks where groupId = ? and userId = ?.
    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:
    groupId - the group ID
    userId - the user ID
    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)
    orderByComparator - the comparator to order the results by (optionally null)
    
    Returns:
    the ordered range of matching document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByG_U_First
```
public static DLFileRank findByG_U_First(long groupId,
                         long userId,
                         OrderByComparator orderByComparator)
                                  throws SystemException,
                                         NoSuchFileRankException
```
    Returns the first document library file rank in the ordered set where groupId = ? and userId = ?.
    
    Parameters:
    groupId - the group ID
    userId - the user ID
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the first matching document library file rank
    
    Throws:
    
    NoSuchFileRankException - if a matching document library file rank could not be found
    
    SystemException - if a system exception occurred
  - fetchByG_U_First
```
public static DLFileRank fetchByG_U_First(long groupId,
                          long userId,
                          OrderByComparator orderByComparator)
                                   throws SystemException
```
    Returns the first document library file rank in the ordered set where groupId = ? and userId = ?.
    
    Parameters:
    groupId - the group ID
    userId - the user ID
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the first matching document library file rank, or null if a matching document library file rank could not be found
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByG_U_Last
```
public static DLFileRank findByG_U_Last(long groupId,
                        long userId,
                        OrderByComparator orderByComparator)
                                 throws SystemException,
                                        NoSuchFileRankException
```
    Returns the last document library file rank in the ordered set where groupId = ? and userId = ?.
    
    Parameters:
    groupId - the group ID
    userId - the user ID
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the last matching document library file rank
    
    Throws:
    
    NoSuchFileRankException - if a matching document library file rank could not be found
    
    SystemException - if a system exception occurred
  - fetchByG_U_Last
```
public static DLFileRank fetchByG_U_Last(long groupId,
                         long userId,
                         OrderByComparator orderByComparator)
                                  throws SystemException
```
    Returns the last document library file rank in the ordered set where groupId = ? and userId = ?.
    
    Parameters:
    groupId - the group ID
    userId - the user ID
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the last matching document library file rank, or null if a matching document library file rank could not be found
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByG_U_PrevAndNext
```
public static DLFileRank[] findByG_U_PrevAndNext(long fileRankId,
                                 long groupId,
                                 long userId,
                                 OrderByComparator orderByComparator)
                                          throws SystemException,
                                                 NoSuchFileRankException
```
    Returns the document library file ranks before and after the current document library file rank in the ordered set where groupId = ? and userId = ?.
    
    Parameters:
    fileRankId - the primary key of the current document library file rank
    groupId - the group ID
    userId - the user ID
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the previous, current, and next document library file rank
    
    Throws:
    
    NoSuchFileRankException - if a document library file rank with the primary key could not be found
    
    SystemException - if a system exception occurred
  - removeByG_U
```
public static void removeByG_U(long groupId,
               long userId)
                        throws SystemException
```
    Removes all the document library file ranks where groupId = ? and userId = ? from the database.
    
    Parameters:
    groupId - the group ID
    userId - the user ID
    
    Throws:
    
    SystemException - if a system exception occurred
  - countByG_U
```
public static int countByG_U(long groupId,
             long userId)
                      throws SystemException
```
    Returns the number of document library file ranks where groupId = ? and userId = ?.
    
    Parameters:
    groupId - the group ID
    userId - the user ID
    
    Returns:
    the number of matching document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByG_U_A
```
public static java.util.List<DLFileRank> findByG_U_A(long groupId,
                                     long userId,
                                     boolean active)
                                              throws SystemException
```
    Returns all the document library file ranks where groupId = ? and userId = ? and active = ?.
    
    Parameters:
    groupId - the group ID
    userId - the user ID
    active - the active
    
    Returns:
    the matching document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByG_U_A
```
public static java.util.List<DLFileRank> findByG_U_A(long groupId,
                                     long userId,
                                     boolean active,
                                     int start,
                                     int end)
                                              throws SystemException
```
    Returns a range of all the document library file ranks where groupId = ? and userId = ? and active = ?.
    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:
    groupId - the group ID
    userId - the user ID
    active - the active
    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 matching document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByG_U_A
```
public static java.util.List<DLFileRank> findByG_U_A(long groupId,
                                     long userId,
                                     boolean active,
                                     int start,
                                     int end,
                                     OrderByComparator orderByComparator)
                                              throws SystemException
```
    Returns an ordered range of all the document library file ranks where groupId = ? and userId = ? and active = ?.
    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:
    groupId - the group ID
    userId - the user ID
    active - the active
    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)
    orderByComparator - the comparator to order the results by (optionally null)
    
    Returns:
    the ordered range of matching document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByG_U_A_First
```
public static DLFileRank findByG_U_A_First(long groupId,
                           long userId,
                           boolean active,
                           OrderByComparator orderByComparator)
                                    throws SystemException,
                                           NoSuchFileRankException
```
    Returns the first document library file rank in the ordered set where groupId = ? and userId = ? and active = ?.
    
    Parameters:
    groupId - the group ID
    userId - the user ID
    active - the active
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the first matching document library file rank
    
    Throws:
    
    NoSuchFileRankException - if a matching document library file rank could not be found
    
    SystemException - if a system exception occurred
  - fetchByG_U_A_First
```
public static DLFileRank fetchByG_U_A_First(long groupId,
                            long userId,
                            boolean active,
                            OrderByComparator orderByComparator)
                                     throws SystemException
```
    Returns the first document library file rank in the ordered set where groupId = ? and userId = ? and active = ?.
    
    Parameters:
    groupId - the group ID
    userId - the user ID
    active - the active
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the first matching document library file rank, or null if a matching document library file rank could not be found
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByG_U_A_Last
```
public static DLFileRank findByG_U_A_Last(long groupId,
                          long userId,
                          boolean active,
                          OrderByComparator orderByComparator)
                                   throws SystemException,
                                          NoSuchFileRankException
```
    Returns the last document library file rank in the ordered set where groupId = ? and userId = ? and active = ?.
    
    Parameters:
    groupId - the group ID
    userId - the user ID
    active - the active
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the last matching document library file rank
    
    Throws:
    
    NoSuchFileRankException - if a matching document library file rank could not be found
    
    SystemException - if a system exception occurred
  - fetchByG_U_A_Last
```
public static DLFileRank fetchByG_U_A_Last(long groupId,
                           long userId,
                           boolean active,
                           OrderByComparator orderByComparator)
                                    throws SystemException
```
    Returns the last document library file rank in the ordered set where groupId = ? and userId = ? and active = ?.
    
    Parameters:
    groupId - the group ID
    userId - the user ID
    active - the active
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the last matching document library file rank, or null if a matching document library file rank could not be found
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByG_U_A_PrevAndNext
```
public static DLFileRank[] findByG_U_A_PrevAndNext(long fileRankId,
                                   long groupId,
                                   long userId,
                                   boolean active,
                                   OrderByComparator orderByComparator)
                                            throws SystemException,
                                                   NoSuchFileRankException
```
    Returns the document library file ranks before and after the current document library file rank in the ordered set where groupId = ? and userId = ? and active = ?.
    
    Parameters:
    fileRankId - the primary key of the current document library file rank
    groupId - the group ID
    userId - the user ID
    active - the active
    orderByComparator - the comparator to order the set by (optionally null)
    
    Returns:
    the previous, current, and next document library file rank
    
    Throws:
    
    NoSuchFileRankException - if a document library file rank with the primary key could not be found
    
    SystemException - if a system exception occurred
  - removeByG_U_A
```
public static void removeByG_U_A(long groupId,
                 long userId,
                 boolean active)
                          throws SystemException
```
    Removes all the document library file ranks where groupId = ? and userId = ? and active = ? from the database.
    
    Parameters:
    groupId - the group ID
    userId - the user ID
    active - the active
    
    Throws:
    
    SystemException - if a system exception occurred
  - countByG_U_A
```
public static int countByG_U_A(long groupId,
               long userId,
               boolean active)
                        throws SystemException
```
    Returns the number of document library file ranks where groupId = ? and userId = ? and active = ?.
    
    Parameters:
    groupId - the group ID
    userId - the user ID
    active - the active
    
    Returns:
    the number of matching document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - findByC_U_F
```
public static DLFileRank findByC_U_F(long companyId,
                     long userId,
                     long fileEntryId)
                              throws SystemException,
                                     NoSuchFileRankException
```
    Returns the document library file rank where companyId = ? and userId = ? and fileEntryId = ? or throws a NoSuchFileRankException if it could not be found.
    
    Parameters:
    companyId - the company ID
    userId - the user ID
    fileEntryId - the file entry ID
    
    Returns:
    the matching document library file rank
    
    Throws:
    
    NoSuchFileRankException - if a matching document library file rank could not be found
    
    SystemException - if a system exception occurred
  - fetchByC_U_F
```
public static DLFileRank fetchByC_U_F(long companyId,
                      long userId,
                      long fileEntryId)
                               throws SystemException
```
    Returns the document library file rank where companyId = ? and userId = ? and fileEntryId = ? or returns null if it could not be found. Uses the finder cache.
    
    Parameters:
    companyId - the company ID
    userId - the user ID
    fileEntryId - the file entry ID
    
    Returns:
    the matching document library file rank, or null if a matching document library file rank could not be found
    
    Throws:
    
    SystemException - if a system exception occurred
  - fetchByC_U_F
```
public static DLFileRank fetchByC_U_F(long companyId,
                      long userId,
                      long fileEntryId,
                      boolean retrieveFromCache)
                               throws SystemException
```
    Returns the document library file rank where companyId = ? and userId = ? and fileEntryId = ? or returns null if it could not be found, optionally using the finder cache.
    
    Parameters:
    companyId - the company ID
    userId - the user ID
    fileEntryId - the file entry ID
    retrieveFromCache - whether to use the finder cache
    
    Returns:
    the matching document library file rank, or null if a matching document library file rank could not be found
    
    Throws:
    
    SystemException - if a system exception occurred
  - removeByC_U_F
```
public static DLFileRank removeByC_U_F(long companyId,
                       long userId,
                       long fileEntryId)
                                throws SystemException,
                                       NoSuchFileRankException
```
    Removes the document library file rank where companyId = ? and userId = ? and fileEntryId = ? from the database.
    
    Parameters:
    companyId - the company ID
    userId - the user ID
    fileEntryId - the file entry ID
    
    Returns:
    the document library file rank that was removed
    
    Throws:
    
    SystemException - if a system exception occurred
    
    NoSuchFileRankException
  - countByC_U_F
```
public static int countByC_U_F(long companyId,
               long userId,
               long fileEntryId)
                        throws SystemException
```
    Returns the number of document library file ranks where companyId = ? and userId = ? and fileEntryId = ?.
    
    Parameters:
    companyId - the company ID
    userId - the user ID
    fileEntryId - the file entry ID
    
    Returns:
    the number of matching document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - cacheResult
```
public static void cacheResult(DLFileRank dlFileRank)
```
    Caches the document library file rank in the entity cache if it is enabled.
    
    Parameters:
    dlFileRank - the document library file rank
  - cacheResult
```
public static void cacheResult(java.util.List<DLFileRank> dlFileRanks)
```
    Caches the document library file ranks in the entity cache if it is enabled.
    
    Parameters:
    dlFileRanks - the document library file ranks
  - create
```
public static DLFileRank create(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
  - remove
```
public static DLFileRank remove(long fileRankId)
                         throws SystemException,
                                NoSuchFileRankException
```
    Removes 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:
    
    NoSuchFileRankException - if a document library file rank with the primary key could not be found
    
    SystemException - if a system exception occurred
  - updateImpl
```
public static DLFileRank updateImpl(DLFileRank dlFileRank)
                             throws SystemException
```
    Throws:
    
    SystemException
  - findByPrimaryKey
```
public static DLFileRank findByPrimaryKey(long fileRankId)
                                   throws SystemException,
                                          NoSuchFileRankException
```
    Returns the document library file rank with the primary key or throws a NoSuchFileRankException if it could not be found.
    
    Parameters:
    fileRankId - the primary key of the document library file rank
    
    Returns:
    the document library file rank
    
    Throws:
    
    NoSuchFileRankException - if a document library file rank with the primary key could not be found
    
    SystemException - if a system exception occurred
  - fetchByPrimaryKey
```
public static DLFileRank fetchByPrimaryKey(long fileRankId)
                                    throws SystemException
```
    Returns the document library file rank with the primary key or returns null if it could not be found.
    
    Parameters:
    fileRankId - the primary key of the document library file rank
    
    Returns:
    the document library file rank, or null if a document library file rank with the primary key could not be found
    
    Throws:
    
    SystemException - if a system exception occurred
  - findAll
```
public static java.util.List<DLFileRank> findAll()
                                          throws SystemException
```
    Returns all the document library file ranks.
    
    Returns:
    the document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - findAll
```
public static java.util.List<DLFileRank> findAll(int start,
                                 int end)
                                          throws SystemException
```
    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
    
    Throws:
    
    SystemException - if a system exception occurred
  - findAll
```
public static java.util.List<DLFileRank> findAll(int start,
                                 int end,
                                 OrderByComparator orderByComparator)
                                          throws SystemException
```
    Returns an ordered 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)
    orderByComparator - the comparator to order the results by (optionally null)
    
    Returns:
    the ordered range of document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - removeAll
```
public static void removeAll()
                      throws SystemException
```
    Removes all the document library file ranks from the database.
    
    Throws:
    
    SystemException - if a system exception occurred
  - countAll
```
public static int countAll()
                    throws SystemException
```
    Returns the number of document library file ranks.
    
    Returns:
    the number of document library file ranks
    
    Throws:
    
    SystemException - if a system exception occurred
  - getPersistence
```
public static DLFileRankPersistence getPersistence()
```
  - setPersistence
```
public void setPersistence(DLFileRankPersistence persistence)
```
    Deprecated. As of 6.2.0

Class DLFileRankUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DLFileRankUtil

Method Detail

clearCache

clearCache

countWithDynamicQuery

findWithDynamicQuery

findWithDynamicQuery

findWithDynamicQuery

update

update

findByUserId

findByUserId

findByUserId

findByUserId_First

fetchByUserId_First

findByUserId_Last

fetchByUserId_Last

findByUserId_PrevAndNext

removeByUserId

countByUserId

findByFileEntryId

findByFileEntryId

findByFileEntryId

findByFileEntryId_First

fetchByFileEntryId_First

findByFileEntryId_Last

fetchByFileEntryId_Last

findByFileEntryId_PrevAndNext

removeByFileEntryId

countByFileEntryId

findByG_U

findByG_U

findByG_U

findByG_U_First

fetchByG_U_First

findByG_U_Last

fetchByG_U_Last

findByG_U_PrevAndNext

removeByG_U

countByG_U

findByG_U_A

findByG_U_A

findByG_U_A

findByG_U_A_First

fetchByG_U_A_First

findByG_U_A_Last

fetchByG_U_A_Last

findByG_U_A_PrevAndNext

removeByG_U_A

countByG_U_A

findByC_U_F

fetchByC_U_F

fetchByC_U_F

removeByC_U_F

countByC_U_F

cacheResult

cacheResult

create

remove

updateImpl

findByPrimaryKey

fetchByPrimaryKey

findAll

findAll

findAll

removeAll

countAll

getPersistence

setPersistence