Liferay 6.2-ce-ga5

com.liferay.portlet.documentlibrary.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.

See Also:
DLFileRankLocalServiceUtil, com.liferay.portlet.documentlibrary.service.base.DLFileRankLocalServiceBaseImpl, com.liferay.portlet.documentlibrary.service.impl.DLFileRankLocalServiceImpl

Method Summary
 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)
           
 void disableFileRanks(long fileEntryId)
           
 void disableFileRanksByFolderId(long folderId)
           
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 void enableFileRanks(long fileEntryId)
           
 void enableFileRanksByFolderId(long folderId)
           
 DLFileRank fetchDLFileRank(long fileRankId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 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)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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)
                         throws SystemException
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
Throws:
SystemException - if a system exception occurred

createDLFileRank

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(long fileRankId)
                            throws PortalException,
                                   SystemException
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
SystemException - if a system exception occurred

deleteDLFileRank

@Indexable(type=DELETE)
DLFileRank deleteDLFileRank(DLFileRank dlFileRank)
                            throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchDLFileRank

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileRank fetchDLFileRank(long fileRankId)
                           throws SystemException
Throws:
SystemException

getDLFileRank

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileRank getDLFileRank(long fileRankId)
                         throws PortalException,
                                SystemException
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
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getDLFileRanks

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

getDLFileRanksCount

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

updateDLFileRank

@Indexable(type=REINDEX)
DLFileRank updateDLFileRank(DLFileRank dlFileRank)
                            throws SystemException
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
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addFileRank

DLFileRank addFileRank(long groupId,
                       long companyId,
                       long userId,
                       long fileEntryId,
                       ServiceContext serviceContext)
                       throws SystemException
Throws:
SystemException

checkFileRanks

void checkFileRanks()
                    throws SystemException
Throws:
SystemException

deleteFileRank

@SystemEvent(action=1,
             send=false,
             type=1)
void deleteFileRank(DLFileRank dlFileRank)
                    throws SystemException
Throws:
SystemException

deleteFileRank

void deleteFileRank(long fileRankId)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

deleteFileRanksByFileEntryId

void deleteFileRanksByFileEntryId(long fileEntryId)
                                  throws SystemException
Throws:
SystemException

deleteFileRanksByUserId

void deleteFileRanksByUserId(long userId)
                             throws SystemException
Throws:
SystemException

disableFileRanks

void disableFileRanks(long fileEntryId)
                      throws SystemException
Throws:
SystemException

disableFileRanksByFolderId

void disableFileRanksByFolderId(long folderId)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

enableFileRanks

void enableFileRanks(long fileEntryId)
                     throws SystemException
Throws:
SystemException

enableFileRanksByFolderId

void enableFileRanksByFolderId(long folderId)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

getFileRanks

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

updateFileRank

DLFileRank updateFileRank(long groupId,
                          long companyId,
                          long userId,
                          long fileEntryId,
                          ServiceContext serviceContext)
                          throws SystemException
Throws:
SystemException

Liferay 6.2-ce-ga5