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 DLFileShortcut. 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 DLFileShortcutLocalServiceUtil 035 * @see com.liferay.portlet.documentlibrary.service.base.DLFileShortcutLocalServiceBaseImpl 036 * @see com.liferay.portlet.documentlibrary.service.impl.DLFileShortcutLocalServiceImpl 037 * @generated 038 */ 039 @ProviderType 040 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 041 PortalException.class, SystemException.class}) 042 public interface DLFileShortcutLocalService extends BaseLocalService, 043 PersistedModelLocalService { 044 /* 045 * NOTE FOR DEVELOPERS: 046 * 047 * Never modify or reference this interface directly. Always use {@link DLFileShortcutLocalServiceUtil} to access the document library file shortcut local service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFileShortcutLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 048 */ 049 050 /** 051 * Adds the document library file shortcut to the database. Also notifies the appropriate model listeners. 052 * 053 * @param dlFileShortcut the document library file shortcut 054 * @return the document library file shortcut that was added 055 * @throws SystemException if a system exception occurred 056 */ 057 public com.liferay.portlet.documentlibrary.model.DLFileShortcut addDLFileShortcut( 058 com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut) 059 throws com.liferay.portal.kernel.exception.SystemException; 060 061 /** 062 * Creates a new document library file shortcut with the primary key. Does not add the document library file shortcut to the database. 063 * 064 * @param fileShortcutId the primary key for the new document library file shortcut 065 * @return the new document library file shortcut 066 */ 067 public com.liferay.portlet.documentlibrary.model.DLFileShortcut createDLFileShortcut( 068 long fileShortcutId); 069 070 /** 071 * Deletes the document library file shortcut with the primary key from the database. Also notifies the appropriate model listeners. 072 * 073 * @param fileShortcutId the primary key of the document library file shortcut 074 * @return the document library file shortcut that was removed 075 * @throws PortalException if a document library file shortcut with the primary key could not be found 076 * @throws SystemException if a system exception occurred 077 */ 078 public com.liferay.portlet.documentlibrary.model.DLFileShortcut deleteDLFileShortcut( 079 long fileShortcutId) 080 throws com.liferay.portal.kernel.exception.PortalException, 081 com.liferay.portal.kernel.exception.SystemException; 082 083 /** 084 * Deletes the document library file shortcut from the database. Also notifies the appropriate model listeners. 085 * 086 * @param dlFileShortcut the document library file shortcut 087 * @return the document library file shortcut that was removed 088 * @throws SystemException if a system exception occurred 089 */ 090 public com.liferay.portlet.documentlibrary.model.DLFileShortcut deleteDLFileShortcut( 091 com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut) 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.DLFileShortcutModelImpl}. 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.DLFileShortcutModelImpl}. 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.DLFileShortcut fetchDLFileShortcut( 173 long fileShortcutId) 174 throws com.liferay.portal.kernel.exception.SystemException; 175 176 /** 177 * Returns the document library file shortcut with the matching UUID and company. 178 * 179 * @param uuid the document library file shortcut's UUID 180 * @param companyId the primary key of the company 181 * @return the matching document library file shortcut, or <code>null</code> if a matching document library file shortcut 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.DLFileShortcut fetchDLFileShortcutByUuidAndCompanyId( 186 java.lang.String uuid, long companyId) 187 throws com.liferay.portal.kernel.exception.SystemException; 188 189 /** 190 * Returns the document library file shortcut matching the UUID and group. 191 * 192 * @param uuid the document library file shortcut's UUID 193 * @param groupId the primary key of the group 194 * @return the matching document library file shortcut, or <code>null</code> if a matching document library file shortcut could not be found 195 * @throws SystemException if a system exception occurred 196 */ 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public com.liferay.portlet.documentlibrary.model.DLFileShortcut fetchDLFileShortcutByUuidAndGroupId( 199 java.lang.String uuid, long groupId) 200 throws com.liferay.portal.kernel.exception.SystemException; 201 202 /** 203 * Returns the document library file shortcut with the primary key. 204 * 205 * @param fileShortcutId the primary key of the document library file shortcut 206 * @return the document library file shortcut 207 * @throws PortalException if a document library file shortcut with the primary key could not be found 208 * @throws SystemException if a system exception occurred 209 */ 210 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 211 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getDLFileShortcut( 212 long fileShortcutId) 213 throws com.liferay.portal.kernel.exception.PortalException, 214 com.liferay.portal.kernel.exception.SystemException; 215 216 @Override 217 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 218 public com.liferay.portal.model.PersistedModel getPersistedModel( 219 java.io.Serializable primaryKeyObj) 220 throws com.liferay.portal.kernel.exception.PortalException, 221 com.liferay.portal.kernel.exception.SystemException; 222 223 /** 224 * Returns the document library file shortcut with the matching UUID and company. 225 * 226 * @param uuid the document library file shortcut's UUID 227 * @param companyId the primary key of the company 228 * @return the matching document library file shortcut 229 * @throws PortalException if a matching document library file shortcut could not be found 230 * @throws SystemException if a system exception occurred 231 */ 232 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 233 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getDLFileShortcutByUuidAndCompanyId( 234 java.lang.String uuid, long companyId) 235 throws com.liferay.portal.kernel.exception.PortalException, 236 com.liferay.portal.kernel.exception.SystemException; 237 238 /** 239 * Returns the document library file shortcut matching the UUID and group. 240 * 241 * @param uuid the document library file shortcut's UUID 242 * @param groupId the primary key of the group 243 * @return the matching document library file shortcut 244 * @throws PortalException if a matching document library file shortcut could not be found 245 * @throws SystemException if a system exception occurred 246 */ 247 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 248 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getDLFileShortcutByUuidAndGroupId( 249 java.lang.String uuid, long groupId) 250 throws com.liferay.portal.kernel.exception.PortalException, 251 com.liferay.portal.kernel.exception.SystemException; 252 253 /** 254 * Returns a range of all the document library file shortcuts. 255 * 256 * <p> 257 * 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.DLFileShortcutModelImpl}. 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. 258 * </p> 259 * 260 * @param start the lower bound of the range of document library file shortcuts 261 * @param end the upper bound of the range of document library file shortcuts (not inclusive) 262 * @return the range of document library file shortcuts 263 * @throws SystemException if a system exception occurred 264 */ 265 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 266 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileShortcut> getDLFileShortcuts( 267 int start, int end) 268 throws com.liferay.portal.kernel.exception.SystemException; 269 270 /** 271 * Returns the number of document library file shortcuts. 272 * 273 * @return the number of document library file shortcuts 274 * @throws SystemException if a system exception occurred 275 */ 276 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 277 public int getDLFileShortcutsCount() 278 throws com.liferay.portal.kernel.exception.SystemException; 279 280 /** 281 * Updates the document library file shortcut in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 282 * 283 * @param dlFileShortcut the document library file shortcut 284 * @return the document library file shortcut that was updated 285 * @throws SystemException if a system exception occurred 286 */ 287 public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateDLFileShortcut( 288 com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut) 289 throws com.liferay.portal.kernel.exception.SystemException; 290 291 /** 292 * Returns the Spring bean ID for this bean. 293 * 294 * @return the Spring bean ID for this bean 295 */ 296 public java.lang.String getBeanIdentifier(); 297 298 /** 299 * Sets the Spring bean ID for this bean. 300 * 301 * @param beanIdentifier the Spring bean ID for this bean 302 */ 303 public void setBeanIdentifier(java.lang.String beanIdentifier); 304 305 public com.liferay.portlet.documentlibrary.model.DLFileShortcut addFileShortcut( 306 long userId, long groupId, long folderId, long toFileEntryId, 307 com.liferay.portal.service.ServiceContext serviceContext) 308 throws com.liferay.portal.kernel.exception.PortalException, 309 com.liferay.portal.kernel.exception.SystemException; 310 311 public void addFileShortcutResources( 312 com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut, 313 boolean addGroupPermissions, boolean addGuestPermissions) 314 throws com.liferay.portal.kernel.exception.PortalException, 315 com.liferay.portal.kernel.exception.SystemException; 316 317 public void addFileShortcutResources( 318 com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut, 319 java.lang.String[] groupPermissions, java.lang.String[] guestPermissions) 320 throws com.liferay.portal.kernel.exception.PortalException, 321 com.liferay.portal.kernel.exception.SystemException; 322 323 public void addFileShortcutResources(long fileShortcutId, 324 boolean addGroupPermissions, boolean addGuestPermissions) 325 throws com.liferay.portal.kernel.exception.PortalException, 326 com.liferay.portal.kernel.exception.SystemException; 327 328 public void addFileShortcutResources(long fileShortcutId, 329 java.lang.String[] groupPermissions, java.lang.String[] guestPermissions) 330 throws com.liferay.portal.kernel.exception.PortalException, 331 com.liferay.portal.kernel.exception.SystemException; 332 333 public void deleteFileShortcut( 334 com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut) 335 throws com.liferay.portal.kernel.exception.PortalException, 336 com.liferay.portal.kernel.exception.SystemException; 337 338 public void deleteFileShortcut(long fileShortcutId) 339 throws com.liferay.portal.kernel.exception.PortalException, 340 com.liferay.portal.kernel.exception.SystemException; 341 342 public void deleteFileShortcuts(long toFileEntryId) 343 throws com.liferay.portal.kernel.exception.PortalException, 344 com.liferay.portal.kernel.exception.SystemException; 345 346 public void deleteFileShortcuts(long groupId, long folderId) 347 throws com.liferay.portal.kernel.exception.PortalException, 348 com.liferay.portal.kernel.exception.SystemException; 349 350 public void deleteFileShortcuts(long groupId, long folderId, 351 boolean includeTrashedEntries) 352 throws com.liferay.portal.kernel.exception.PortalException, 353 com.liferay.portal.kernel.exception.SystemException; 354 355 public void disableFileShortcuts(long toFileEntryId) 356 throws com.liferay.portal.kernel.exception.SystemException; 357 358 public void enableFileShortcuts(long toFileEntryId) 359 throws com.liferay.portal.kernel.exception.SystemException; 360 361 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 362 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut( 363 long fileShortcutId) 364 throws com.liferay.portal.kernel.exception.PortalException, 365 com.liferay.portal.kernel.exception.SystemException; 366 367 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 368 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileShortcut> getFileShortcuts( 369 long groupId, long folderId, boolean active, int status, int start, 370 int end) throws com.liferay.portal.kernel.exception.SystemException; 371 372 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 373 public int getFileShortcutsCount(long groupId, long folderId, 374 boolean active, int status) 375 throws com.liferay.portal.kernel.exception.SystemException; 376 377 public void rebuildTree(long companyId) 378 throws com.liferay.portal.kernel.exception.SystemException; 379 380 public void updateAsset(long userId, 381 com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut, 382 long[] assetCategoryIds, java.lang.String[] assetTagNames) 383 throws com.liferay.portal.kernel.exception.PortalException, 384 com.liferay.portal.kernel.exception.SystemException; 385 386 public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut( 387 long userId, long fileShortcutId, long folderId, long toFileEntryId, 388 com.liferay.portal.service.ServiceContext serviceContext) 389 throws com.liferay.portal.kernel.exception.PortalException, 390 com.liferay.portal.kernel.exception.SystemException; 391 392 public void updateFileShortcuts(long oldToFileEntryId, long newToFileEntryId) 393 throws com.liferay.portal.kernel.exception.SystemException; 394 395 public void updateStatus(long userId, long fileShortcutId, int status, 396 com.liferay.portal.service.ServiceContext serviceContext) 397 throws com.liferay.portal.kernel.exception.PortalException, 398 com.liferay.portal.kernel.exception.SystemException; 399 }