com.liferay.document.library.kernel.service

Interface DLFileRankLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

DLFileRankLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DLFileRankLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for DLFileRank. 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:

DLFileRankLocalServiceUtil, DLFileRankLocalServiceBaseImpl, DLFileRankLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
DLFileRank	addDLFileRank(DLFileRank dlFileRank) Adds the document library file rank to the database.
DLFileRank	addFileRank(long groupId, long companyId, long userId, long fileEntryId, ServiceContext serviceContext)
void	checkFileRanks()
DLFileRank	createDLFileRank(long fileRankId) Creates a new document library file rank with the primary key.
DLFileRank	deleteDLFileRank(DLFileRank dlFileRank) Deletes the document library file rank from the database.
DLFileRank	deleteDLFileRank(long fileRankId) Deletes the document library file rank with the primary key from the database.
void	deleteFileRank(DLFileRank dlFileRank)
void	deleteFileRank(long fileRankId)
void	deleteFileRanksByFileEntryId(long fileEntryId)
void	deleteFileRanksByUserId(long userId)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
void	disableFileRanks(long fileEntryId)
void	disableFileRanksByFolderId(long folderId)
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
void	enableFileRanks(long fileEntryId)
void	enableFileRanksByFolderId(long folderId)
DLFileRank	fetchDLFileRank(long fileRankId)
ActionableDynamicQuery	getActionableDynamicQuery()
DLFileRank	getDLFileRank(long fileRankId) Returns the document library file rank with the primary key.
List<DLFileRank>	getDLFileRanks(int start, int end) Returns a range of all the document library file ranks.
int	getDLFileRanksCount() Returns the number of document library file ranks.
List<DLFileRank>	getFileRanks(long groupId, long userId)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
DLFileRank	updateDLFileRank(DLFileRank dlFileRank) Updates the document library file rank in the database or adds it if it does not yet exist.
DLFileRank	updateFileRank(long groupId, long companyId, long userId, long fileEntryId, ServiceContext serviceContext)

Method Detail

addDLFileRank

@Indexable(type=REINDEX)
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

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

checkFileRanks

void checkFileRanks()

createDLFileRank

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

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

@SystemEvent(type=1)
void deleteFileRank(DLFileRank dlFileRank)

deleteFileRank

void deleteFileRank(long fileRankId)
             throws PortalException

Throws:

PortalException

deleteFileRanksByFileEntryId

void deleteFileRanksByFileEntryId(long fileEntryId)

deleteFileRanksByUserId

void deleteFileRanksByUserId(long userId)

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

disableFileRanks

void disableFileRanks(long fileEntryId)

disableFileRanksByFolderId

void disableFileRanksByFolderId(long folderId)
                         throws PortalException

Throws:

PortalException

dynamicQuery

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

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end)

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end,
                                                                                            OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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

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

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

enableFileRanks

void enableFileRanks(long fileEntryId)

enableFileRanksByFolderId

void enableFileRanksByFolderId(long folderId)
                        throws PortalException

Throws:

PortalException

fetchDLFileRank

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileRank fetchDLFileRank(long fileRankId)

getActionableDynamicQuery

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

getDLFileRank

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

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

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

Returns the number of document library file ranks.

Returns:

the number of document library file ranks

getFileRanks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileRank> getFileRanks(long groupId,
                                                                                                 long userId)

getIndexableActionableDynamicQuery

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

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

updateDLFileRank

@Indexable(type=REINDEX)
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

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