001 /** 002 * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portlet.documentlibrary.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.exception.PortalException; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.kernel.transaction.Isolation; 022 import com.liferay.portal.kernel.transaction.Propagation; 023 import com.liferay.portal.kernel.transaction.Transactional; 024 import com.liferay.portal.service.BaseLocalService; 025 import com.liferay.portal.service.PersistedModelLocalService; 026 027 /** 028 * Provides the local service interface for DLFileRank. Methods of this 029 * service will not have security checks based on the propagated JAAS 030 * credentials because this service can only be accessed from within the same 031 * VM. 032 * 033 * @author Brian Wing Shun Chan 034 * @see DLFileRankLocalServiceUtil 035 * @see com.liferay.portlet.documentlibrary.service.base.DLFileRankLocalServiceBaseImpl 036 * @see com.liferay.portlet.documentlibrary.service.impl.DLFileRankLocalServiceImpl 037 * @generated 038 */ 039 @ProviderType 040 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 041 PortalException.class, SystemException.class}) 042 public interface DLFileRankLocalService extends BaseLocalService, 043 PersistedModelLocalService { 044 /* 045 * NOTE FOR DEVELOPERS: 046 * 047 * 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. 048 */ 049 050 /** 051 * Adds the document library file rank to the database. Also notifies the appropriate model listeners. 052 * 053 * @param dlFileRank the document library file rank 054 * @return the document library file rank that was added 055 * @throws SystemException if a system exception occurred 056 */ 057 public com.liferay.portlet.documentlibrary.model.DLFileRank addDLFileRank( 058 com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank) 059 throws com.liferay.portal.kernel.exception.SystemException; 060 061 /** 062 * Creates a new document library file rank with the primary key. Does not add the document library file rank to the database. 063 * 064 * @param fileRankId the primary key for the new document library file rank 065 * @return the new document library file rank 066 */ 067 public com.liferay.portlet.documentlibrary.model.DLFileRank createDLFileRank( 068 long fileRankId); 069 070 /** 071 * Deletes the document library file rank with the primary key from the database. Also notifies the appropriate model listeners. 072 * 073 * @param fileRankId the primary key of the document library file rank 074 * @return the document library file rank that was removed 075 * @throws PortalException if a document library file rank with the primary key could not be found 076 * @throws SystemException if a system exception occurred 077 */ 078 public com.liferay.portlet.documentlibrary.model.DLFileRank deleteDLFileRank( 079 long fileRankId) 080 throws com.liferay.portal.kernel.exception.PortalException, 081 com.liferay.portal.kernel.exception.SystemException; 082 083 /** 084 * Deletes the document library file rank from the database. Also notifies the appropriate model listeners. 085 * 086 * @param dlFileRank the document library file rank 087 * @return the document library file rank that was removed 088 * @throws SystemException if a system exception occurred 089 */ 090 public com.liferay.portlet.documentlibrary.model.DLFileRank deleteDLFileRank( 091 com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank) 092 throws com.liferay.portal.kernel.exception.SystemException; 093 094 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 095 096 /** 097 * Performs a dynamic query on the database and returns the matching rows. 098 * 099 * @param dynamicQuery the dynamic query 100 * @return the matching rows 101 * @throws SystemException if a system exception occurred 102 */ 103 @SuppressWarnings("rawtypes") 104 public java.util.List dynamicQuery( 105 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 106 throws com.liferay.portal.kernel.exception.SystemException; 107 108 /** 109 * Performs a dynamic query on the database and returns a range of the matching rows. 110 * 111 * <p> 112 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> 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 <code>orderByComparator</code> 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. 113 * </p> 114 * 115 * @param dynamicQuery the dynamic query 116 * @param start the lower bound of the range of model instances 117 * @param end the upper bound of the range of model instances (not inclusive) 118 * @return the range of matching rows 119 * @throws SystemException if a system exception occurred 120 */ 121 @SuppressWarnings("rawtypes") 122 public java.util.List dynamicQuery( 123 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 124 int end) throws com.liferay.portal.kernel.exception.SystemException; 125 126 /** 127 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 128 * 129 * <p> 130 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> 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 <code>orderByComparator</code> 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. 131 * </p> 132 * 133 * @param dynamicQuery the dynamic query 134 * @param start the lower bound of the range of model instances 135 * @param end the upper bound of the range of model instances (not inclusive) 136 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 137 * @return the ordered range of matching rows 138 * @throws SystemException if a system exception occurred 139 */ 140 @SuppressWarnings("rawtypes") 141 public java.util.List dynamicQuery( 142 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 143 int end, 144 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 145 throws com.liferay.portal.kernel.exception.SystemException; 146 147 /** 148 * Returns the number of rows that match the dynamic query. 149 * 150 * @param dynamicQuery the dynamic query 151 * @return the number of rows that match the dynamic query 152 * @throws SystemException if a system exception occurred 153 */ 154 public long dynamicQueryCount( 155 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 156 throws com.liferay.portal.kernel.exception.SystemException; 157 158 /** 159 * Returns the number of rows that match the dynamic query. 160 * 161 * @param dynamicQuery the dynamic query 162 * @param projection the projection to apply to the query 163 * @return the number of rows that match the dynamic query 164 * @throws SystemException if a system exception occurred 165 */ 166 public long dynamicQueryCount( 167 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 168 com.liferay.portal.kernel.dao.orm.Projection projection) 169 throws com.liferay.portal.kernel.exception.SystemException; 170 171 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 172 public com.liferay.portlet.documentlibrary.model.DLFileRank fetchDLFileRank( 173 long fileRankId) 174 throws com.liferay.portal.kernel.exception.SystemException; 175 176 /** 177 * Returns the document library file rank with the primary key. 178 * 179 * @param fileRankId the primary key of the document library file rank 180 * @return the document library file rank 181 * @throws PortalException if a document library file rank with the primary key could not be found 182 * @throws SystemException if a system exception occurred 183 */ 184 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 185 public com.liferay.portlet.documentlibrary.model.DLFileRank getDLFileRank( 186 long fileRankId) 187 throws com.liferay.portal.kernel.exception.PortalException, 188 com.liferay.portal.kernel.exception.SystemException; 189 190 @Override 191 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 192 public com.liferay.portal.model.PersistedModel getPersistedModel( 193 java.io.Serializable primaryKeyObj) 194 throws com.liferay.portal.kernel.exception.PortalException, 195 com.liferay.portal.kernel.exception.SystemException; 196 197 /** 198 * Returns a range of all the document library file ranks. 199 * 200 * <p> 201 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> 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 <code>orderByComparator</code> 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. 202 * </p> 203 * 204 * @param start the lower bound of the range of document library file ranks 205 * @param end the upper bound of the range of document library file ranks (not inclusive) 206 * @return the range of document library file ranks 207 * @throws SystemException if a system exception occurred 208 */ 209 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 210 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileRank> getDLFileRanks( 211 int start, int end) 212 throws com.liferay.portal.kernel.exception.SystemException; 213 214 /** 215 * Returns the number of document library file ranks. 216 * 217 * @return the number of document library file ranks 218 * @throws SystemException if a system exception occurred 219 */ 220 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 221 public int getDLFileRanksCount() 222 throws com.liferay.portal.kernel.exception.SystemException; 223 224 /** 225 * Updates the document library file rank in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 226 * 227 * @param dlFileRank the document library file rank 228 * @return the document library file rank that was updated 229 * @throws SystemException if a system exception occurred 230 */ 231 public com.liferay.portlet.documentlibrary.model.DLFileRank updateDLFileRank( 232 com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank) 233 throws com.liferay.portal.kernel.exception.SystemException; 234 235 /** 236 * Returns the Spring bean ID for this bean. 237 * 238 * @return the Spring bean ID for this bean 239 */ 240 public java.lang.String getBeanIdentifier(); 241 242 /** 243 * Sets the Spring bean ID for this bean. 244 * 245 * @param beanIdentifier the Spring bean ID for this bean 246 */ 247 public void setBeanIdentifier(java.lang.String beanIdentifier); 248 249 public com.liferay.portlet.documentlibrary.model.DLFileRank addFileRank( 250 long groupId, long companyId, long userId, long fileEntryId, 251 com.liferay.portal.service.ServiceContext serviceContext) 252 throws com.liferay.portal.kernel.exception.SystemException; 253 254 public void checkFileRanks() 255 throws com.liferay.portal.kernel.exception.SystemException; 256 257 public void deleteFileRank( 258 com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank) 259 throws com.liferay.portal.kernel.exception.SystemException; 260 261 public void deleteFileRank(long fileRankId) 262 throws com.liferay.portal.kernel.exception.PortalException, 263 com.liferay.portal.kernel.exception.SystemException; 264 265 public void deleteFileRanksByFileEntryId(long fileEntryId) 266 throws com.liferay.portal.kernel.exception.SystemException; 267 268 public void deleteFileRanksByUserId(long userId) 269 throws com.liferay.portal.kernel.exception.SystemException; 270 271 public void disableFileRanks(long fileEntryId) 272 throws com.liferay.portal.kernel.exception.SystemException; 273 274 public void disableFileRanksByFolderId(long folderId) 275 throws com.liferay.portal.kernel.exception.PortalException, 276 com.liferay.portal.kernel.exception.SystemException; 277 278 public void enableFileRanks(long fileEntryId) 279 throws com.liferay.portal.kernel.exception.SystemException; 280 281 public void enableFileRanksByFolderId(long folderId) 282 throws com.liferay.portal.kernel.exception.PortalException, 283 com.liferay.portal.kernel.exception.SystemException; 284 285 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 286 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileRank> getFileRanks( 287 long groupId, long userId) 288 throws com.liferay.portal.kernel.exception.SystemException; 289 290 public com.liferay.portlet.documentlibrary.model.DLFileRank updateFileRank( 291 long groupId, long companyId, long userId, long fileEntryId, 292 com.liferay.portal.service.ServiceContext serviceContext) 293 throws com.liferay.portal.kernel.exception.SystemException; 294 }