com.liferay.portlet.documentlibrary.service.DLFileRankLocalService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portlet.documentlibrary.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.model.SystemEventConstants;
import com.liferay.portal.service.BaseLocalService;
import com.liferay.portal.service.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 DLFileRankLocalServiceUtil
* @see com.liferay.portlet.documentlibrary.service.base.DLFileRankLocalServiceBaseImpl
* @see com.liferay.portlet.documentlibrary.service.impl.DLFileRankLocalServiceImpl
* @generated
*/
@ProviderType
@Transactional(isolation = Isolation.PORTAL, rollbackFor = {
PortalException.class, SystemException.class})
public interface DLFileRankLocalService extends BaseLocalService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link DLFileRankLocalServiceUtil} to access the document library file rank local service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFileRankLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the document library file rank to the database. Also notifies the appropriate model listeners.
*
* @param dlFileRank the document library file rank
* @return the document library file rank that was added
* @throws SystemException if a system exception occurred
*/
@com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
public com.liferay.portlet.documentlibrary.model.DLFileRank addDLFileRank(
com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Creates a new document library file rank with the primary key. Does not add the document library file rank to the database.
*
* @param fileRankId the primary key for the new document library file rank
* @return the new document library file rank
*/
public com.liferay.portlet.documentlibrary.model.DLFileRank createDLFileRank(
long fileRankId);
/**
* Deletes the document library file rank with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param fileRankId the primary key of the document library file rank
* @return the document library file rank that was removed
* @throws PortalException if a document library file rank with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
@com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
public com.liferay.portlet.documentlibrary.model.DLFileRank deleteDLFileRank(
long fileRankId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Deletes the document library file rank from the database. Also notifies the appropriate model listeners.
*
* @param dlFileRank the document library file rank
* @return the document library file rank that was removed
* @throws SystemException if a system exception occurred
*/
@com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
public com.liferay.portlet.documentlibrary.model.DLFileRank deleteDLFileRank(
com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank)
throws com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.documentlibrary.model.impl.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) throws com.liferay.portal.kernel.exception.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.documentlibrary.model.impl.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portlet.documentlibrary.model.DLFileRank fetchDLFileRank(
long fileRankId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the document library file rank with the primary key.
*
* @param fileRankId the primary key of the document library file rank
* @return the document library file rank
* @throws PortalException if a document library file rank with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portlet.documentlibrary.model.DLFileRank getDLFileRank(
long fileRankId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.documentlibrary.model.impl.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.
*
*
* @param start the lower bound of the range of document library file ranks
* @param end the upper bound of the range of document library file ranks (not inclusive)
* @return the range of document library file ranks
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getDLFileRanks(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of document library file ranks.
*
* @return the number of document library file ranks
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getDLFileRanksCount()
throws com.liferay.portal.kernel.exception.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.
*
* @param dlFileRank the document library file rank
* @return the document library file rank that was updated
* @throws SystemException if a system exception occurred
*/
@com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
public com.liferay.portlet.documentlibrary.model.DLFileRank updateDLFileRank(
com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the Spring bean ID for this bean.
*
* @return the Spring bean ID for this bean
*/
public java.lang.String getBeanIdentifier();
/**
* Sets the Spring bean ID for this bean.
*
* @param beanIdentifier the Spring bean ID for this bean
*/
public void setBeanIdentifier(java.lang.String beanIdentifier);
public com.liferay.portlet.documentlibrary.model.DLFileRank addFileRank(
long groupId, long companyId, long userId, long fileEntryId,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.SystemException;
public void checkFileRanks()
throws com.liferay.portal.kernel.exception.SystemException;
@com.liferay.portal.kernel.systemevent.SystemEvent(action = SystemEventConstants.ACTION_SKIP, send = false, type = SystemEventConstants.TYPE_DELETE)
public void deleteFileRank(
com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank)
throws com.liferay.portal.kernel.exception.SystemException;
public void deleteFileRank(long fileRankId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void deleteFileRanksByFileEntryId(long fileEntryId)
throws com.liferay.portal.kernel.exception.SystemException;
public void deleteFileRanksByUserId(long userId)
throws com.liferay.portal.kernel.exception.SystemException;
public void disableFileRanks(long fileEntryId)
throws com.liferay.portal.kernel.exception.SystemException;
public void disableFileRanksByFolderId(long folderId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void enableFileRanks(long fileEntryId)
throws com.liferay.portal.kernel.exception.SystemException;
public void enableFileRanksByFolderId(long folderId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getFileRanks(
long groupId, long userId)
throws com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portlet.documentlibrary.model.DLFileRank updateFileRank(
long groupId, long companyId, long userId, long fileEntryId,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.SystemException;
}