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 com.liferay.portal.kernel.exception.PortalException; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.kernel.transaction.Isolation; 020 import com.liferay.portal.kernel.transaction.Propagation; 021 import com.liferay.portal.kernel.transaction.Transactional; 022 import com.liferay.portal.service.BaseLocalService; 023 import com.liferay.portal.service.PersistedModelLocalService; 024 025 /** 026 * Provides the local service interface for DLFileShortcut. Methods of this 027 * service will not have security checks based on the propagated JAAS 028 * credentials because this service can only be accessed from within the same 029 * VM. 030 * 031 * @author Brian Wing Shun Chan 032 * @see DLFileShortcutLocalServiceUtil 033 * @see com.liferay.portlet.documentlibrary.service.base.DLFileShortcutLocalServiceBaseImpl 034 * @see com.liferay.portlet.documentlibrary.service.impl.DLFileShortcutLocalServiceImpl 035 * @generated 036 */ 037 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 038 PortalException.class, SystemException.class}) 039 public interface DLFileShortcutLocalService extends BaseLocalService, 040 PersistedModelLocalService { 041 /* 042 * NOTE FOR DEVELOPERS: 043 * 044 * 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. 045 */ 046 047 /** 048 * Adds the document library file shortcut to the database. Also notifies the appropriate model listeners. 049 * 050 * @param dlFileShortcut the document library file shortcut 051 * @return the document library file shortcut that was added 052 * @throws SystemException if a system exception occurred 053 */ 054 public com.liferay.portlet.documentlibrary.model.DLFileShortcut addDLFileShortcut( 055 com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut) 056 throws com.liferay.portal.kernel.exception.SystemException; 057 058 /** 059 * Creates a new document library file shortcut with the primary key. Does not add the document library file shortcut to the database. 060 * 061 * @param fileShortcutId the primary key for the new document library file shortcut 062 * @return the new document library file shortcut 063 */ 064 public com.liferay.portlet.documentlibrary.model.DLFileShortcut createDLFileShortcut( 065 long fileShortcutId); 066 067 /** 068 * Deletes the document library file shortcut with the primary key from the database. Also notifies the appropriate model listeners. 069 * 070 * @param fileShortcutId the primary key of the document library file shortcut 071 * @return the document library file shortcut that was removed 072 * @throws PortalException if a document library file shortcut with the primary key could not be found 073 * @throws SystemException if a system exception occurred 074 */ 075 public com.liferay.portlet.documentlibrary.model.DLFileShortcut deleteDLFileShortcut( 076 long fileShortcutId) 077 throws com.liferay.portal.kernel.exception.PortalException, 078 com.liferay.portal.kernel.exception.SystemException; 079 080 /** 081 * Deletes the document library file shortcut from the database. Also notifies the appropriate model listeners. 082 * 083 * @param dlFileShortcut the document library file shortcut 084 * @return the document library file shortcut that was removed 085 * @throws SystemException if a system exception occurred 086 */ 087 public com.liferay.portlet.documentlibrary.model.DLFileShortcut deleteDLFileShortcut( 088 com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut) 089 throws com.liferay.portal.kernel.exception.SystemException; 090 091 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 092 093 /** 094 * Performs a dynamic query on the database and returns the matching rows. 095 * 096 * @param dynamicQuery the dynamic query 097 * @return the matching rows 098 * @throws SystemException if a system exception occurred 099 */ 100 @SuppressWarnings("rawtypes") 101 public java.util.List dynamicQuery( 102 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 103 throws com.liferay.portal.kernel.exception.SystemException; 104 105 /** 106 * Performs a dynamic query on the database and returns a range of the matching rows. 107 * 108 * <p> 109 * 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. 110 * </p> 111 * 112 * @param dynamicQuery the dynamic query 113 * @param start the lower bound of the range of model instances 114 * @param end the upper bound of the range of model instances (not inclusive) 115 * @return the range of matching rows 116 * @throws SystemException if a system exception occurred 117 */ 118 @SuppressWarnings("rawtypes") 119 public java.util.List dynamicQuery( 120 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 121 int end) throws com.liferay.portal.kernel.exception.SystemException; 122 123 /** 124 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 125 * 126 * <p> 127 * 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. 128 * </p> 129 * 130 * @param dynamicQuery the dynamic query 131 * @param start the lower bound of the range of model instances 132 * @param end the upper bound of the range of model instances (not inclusive) 133 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 134 * @return the ordered range of matching rows 135 * @throws SystemException if a system exception occurred 136 */ 137 @SuppressWarnings("rawtypes") 138 public java.util.List dynamicQuery( 139 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 140 int end, 141 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 142 throws com.liferay.portal.kernel.exception.SystemException; 143 144 /** 145 * Returns the number of rows that match the dynamic query. 146 * 147 * @param dynamicQuery the dynamic query 148 * @return the number of rows that match the dynamic query 149 * @throws SystemException if a system exception occurred 150 */ 151 public long dynamicQueryCount( 152 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 153 throws com.liferay.portal.kernel.exception.SystemException; 154 155 /** 156 * Returns the number of rows that match the dynamic query. 157 * 158 * @param dynamicQuery the dynamic query 159 * @param projection the projection to apply to the query 160 * @return the number of rows that match the dynamic query 161 * @throws SystemException if a system exception occurred 162 */ 163 public long dynamicQueryCount( 164 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 165 com.liferay.portal.kernel.dao.orm.Projection projection) 166 throws com.liferay.portal.kernel.exception.SystemException; 167 168 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 169 public com.liferay.portlet.documentlibrary.model.DLFileShortcut fetchDLFileShortcut( 170 long fileShortcutId) 171 throws com.liferay.portal.kernel.exception.SystemException; 172 173 /** 174 * Returns the document library file shortcut with the matching UUID and company. 175 * 176 * @param uuid the document library file shortcut's UUID 177 * @param companyId the primary key of the company 178 * @return the matching document library file shortcut, or <code>null</code> if a matching document library file shortcut could not be found 179 * @throws SystemException if a system exception occurred 180 */ 181 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 182 public com.liferay.portlet.documentlibrary.model.DLFileShortcut fetchDLFileShortcutByUuidAndCompanyId( 183 java.lang.String uuid, long companyId) 184 throws com.liferay.portal.kernel.exception.SystemException; 185 186 /** 187 * Returns the document library file shortcut matching the UUID and group. 188 * 189 * @param uuid the document library file shortcut's UUID 190 * @param groupId the primary key of the group 191 * @return the matching document library file shortcut, or <code>null</code> if a matching document library file shortcut could not be found 192 * @throws SystemException if a system exception occurred 193 */ 194 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 195 public com.liferay.portlet.documentlibrary.model.DLFileShortcut fetchDLFileShortcutByUuidAndGroupId( 196 java.lang.String uuid, long groupId) 197 throws com.liferay.portal.kernel.exception.SystemException; 198 199 /** 200 * Returns the document library file shortcut with the primary key. 201 * 202 * @param fileShortcutId the primary key of the document library file shortcut 203 * @return the document library file shortcut 204 * @throws PortalException if a document library file shortcut with the primary key could not be found 205 * @throws SystemException if a system exception occurred 206 */ 207 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 208 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getDLFileShortcut( 209 long fileShortcutId) 210 throws com.liferay.portal.kernel.exception.PortalException, 211 com.liferay.portal.kernel.exception.SystemException; 212 213 @Override 214 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 215 public com.liferay.portal.model.PersistedModel getPersistedModel( 216 java.io.Serializable primaryKeyObj) 217 throws com.liferay.portal.kernel.exception.PortalException, 218 com.liferay.portal.kernel.exception.SystemException; 219 220 /** 221 * Returns the document library file shortcut with the matching UUID and company. 222 * 223 * @param uuid the document library file shortcut's UUID 224 * @param companyId the primary key of the company 225 * @return the matching document library file shortcut 226 * @throws PortalException if a matching document library file shortcut could not be found 227 * @throws SystemException if a system exception occurred 228 */ 229 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 230 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getDLFileShortcutByUuidAndCompanyId( 231 java.lang.String uuid, long companyId) 232 throws com.liferay.portal.kernel.exception.PortalException, 233 com.liferay.portal.kernel.exception.SystemException; 234 235 /** 236 * Returns the document library file shortcut matching the UUID and group. 237 * 238 * @param uuid the document library file shortcut's UUID 239 * @param groupId the primary key of the group 240 * @return the matching document library file shortcut 241 * @throws PortalException if a matching document library file shortcut could not be found 242 * @throws SystemException if a system exception occurred 243 */ 244 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 245 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getDLFileShortcutByUuidAndGroupId( 246 java.lang.String uuid, long groupId) 247 throws com.liferay.portal.kernel.exception.PortalException, 248 com.liferay.portal.kernel.exception.SystemException; 249 250 /** 251 * Returns a range of all the document library file shortcuts. 252 * 253 * <p> 254 * 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. 255 * </p> 256 * 257 * @param start the lower bound of the range of document library file shortcuts 258 * @param end the upper bound of the range of document library file shortcuts (not inclusive) 259 * @return the range of document library file shortcuts 260 * @throws SystemException if a system exception occurred 261 */ 262 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 263 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileShortcut> getDLFileShortcuts( 264 int start, int end) 265 throws com.liferay.portal.kernel.exception.SystemException; 266 267 /** 268 * Returns the number of document library file shortcuts. 269 * 270 * @return the number of document library file shortcuts 271 * @throws SystemException if a system exception occurred 272 */ 273 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 274 public int getDLFileShortcutsCount() 275 throws com.liferay.portal.kernel.exception.SystemException; 276 277 /** 278 * Updates the document library file shortcut in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 279 * 280 * @param dlFileShortcut the document library file shortcut 281 * @return the document library file shortcut that was updated 282 * @throws SystemException if a system exception occurred 283 */ 284 public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateDLFileShortcut( 285 com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut) 286 throws com.liferay.portal.kernel.exception.SystemException; 287 288 /** 289 * Returns the Spring bean ID for this bean. 290 * 291 * @return the Spring bean ID for this bean 292 */ 293 public java.lang.String getBeanIdentifier(); 294 295 /** 296 * Sets the Spring bean ID for this bean. 297 * 298 * @param beanIdentifier the Spring bean ID for this bean 299 */ 300 public void setBeanIdentifier(java.lang.String beanIdentifier); 301 302 public com.liferay.portlet.documentlibrary.model.DLFileShortcut addFileShortcut( 303 long userId, long groupId, long folderId, long toFileEntryId, 304 com.liferay.portal.service.ServiceContext serviceContext) 305 throws com.liferay.portal.kernel.exception.PortalException, 306 com.liferay.portal.kernel.exception.SystemException; 307 308 public void addFileShortcutResources( 309 com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut, 310 boolean addGroupPermissions, boolean addGuestPermissions) 311 throws com.liferay.portal.kernel.exception.PortalException, 312 com.liferay.portal.kernel.exception.SystemException; 313 314 public void addFileShortcutResources( 315 com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut, 316 java.lang.String[] groupPermissions, java.lang.String[] guestPermissions) 317 throws com.liferay.portal.kernel.exception.PortalException, 318 com.liferay.portal.kernel.exception.SystemException; 319 320 public void addFileShortcutResources(long fileShortcutId, 321 boolean addGroupPermissions, boolean addGuestPermissions) 322 throws com.liferay.portal.kernel.exception.PortalException, 323 com.liferay.portal.kernel.exception.SystemException; 324 325 public void addFileShortcutResources(long fileShortcutId, 326 java.lang.String[] groupPermissions, java.lang.String[] guestPermissions) 327 throws com.liferay.portal.kernel.exception.PortalException, 328 com.liferay.portal.kernel.exception.SystemException; 329 330 public void deleteFileShortcut( 331 com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut) 332 throws com.liferay.portal.kernel.exception.PortalException, 333 com.liferay.portal.kernel.exception.SystemException; 334 335 public void deleteFileShortcut(long fileShortcutId) 336 throws com.liferay.portal.kernel.exception.PortalException, 337 com.liferay.portal.kernel.exception.SystemException; 338 339 public void deleteFileShortcuts(long toFileEntryId) 340 throws com.liferay.portal.kernel.exception.PortalException, 341 com.liferay.portal.kernel.exception.SystemException; 342 343 public void deleteFileShortcuts(long groupId, long folderId) 344 throws com.liferay.portal.kernel.exception.PortalException, 345 com.liferay.portal.kernel.exception.SystemException; 346 347 public void deleteFileShortcuts(long groupId, long folderId, 348 boolean includeTrashedEntries) 349 throws com.liferay.portal.kernel.exception.PortalException, 350 com.liferay.portal.kernel.exception.SystemException; 351 352 public void disableFileShortcuts(long toFileEntryId) 353 throws com.liferay.portal.kernel.exception.SystemException; 354 355 public void enableFileShortcuts(long toFileEntryId) 356 throws com.liferay.portal.kernel.exception.SystemException; 357 358 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 359 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut( 360 long fileShortcutId) 361 throws com.liferay.portal.kernel.exception.PortalException, 362 com.liferay.portal.kernel.exception.SystemException; 363 364 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 365 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileShortcut> getFileShortcuts( 366 long groupId, long folderId, boolean active, int status, int start, 367 int end) throws com.liferay.portal.kernel.exception.SystemException; 368 369 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 370 public int getFileShortcutsCount(long groupId, long folderId, 371 boolean active, int status) 372 throws com.liferay.portal.kernel.exception.SystemException; 373 374 public void rebuildTree(long companyId) 375 throws com.liferay.portal.kernel.exception.PortalException, 376 com.liferay.portal.kernel.exception.SystemException; 377 378 public void updateAsset(long userId, 379 com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut, 380 long[] assetCategoryIds, java.lang.String[] assetTagNames) 381 throws com.liferay.portal.kernel.exception.PortalException, 382 com.liferay.portal.kernel.exception.SystemException; 383 384 public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut( 385 long userId, long fileShortcutId, long folderId, long toFileEntryId, 386 com.liferay.portal.service.ServiceContext serviceContext) 387 throws com.liferay.portal.kernel.exception.PortalException, 388 com.liferay.portal.kernel.exception.SystemException; 389 390 public void updateFileShortcuts(long oldToFileEntryId, long newToFileEntryId) 391 throws com.liferay.portal.kernel.exception.SystemException; 392 393 public void updateStatus(long userId, long fileShortcutId, int status, 394 com.liferay.portal.service.ServiceContext serviceContext) 395 throws com.liferay.portal.kernel.exception.PortalException, 396 com.liferay.portal.kernel.exception.SystemException; 397 }