001 /** 002 * Copyright (c) 2000-2012 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.PersistedModelLocalService; 023 024 /** 025 * The interface for the document library file shortcut local service. 026 * 027 * <p> 028 * This is a local service. 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. 029 * </p> 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 PersistedModelLocalService { 040 /* 041 * NOTE FOR DEVELOPERS: 042 * 043 * 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. 044 */ 045 046 /** 047 * Adds the document library file shortcut to the database. Also notifies the appropriate model listeners. 048 * 049 * @param dlFileShortcut the document library file shortcut 050 * @return the document library file shortcut that was added 051 * @throws SystemException if a system exception occurred 052 */ 053 public com.liferay.portlet.documentlibrary.model.DLFileShortcut addDLFileShortcut( 054 com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut) 055 throws com.liferay.portal.kernel.exception.SystemException; 056 057 /** 058 * Creates a new document library file shortcut with the primary key. Does not add the document library file shortcut to the database. 059 * 060 * @param fileShortcutId the primary key for the new document library file shortcut 061 * @return the new document library file shortcut 062 */ 063 public com.liferay.portlet.documentlibrary.model.DLFileShortcut createDLFileShortcut( 064 long fileShortcutId); 065 066 /** 067 * Deletes the document library file shortcut with the primary key from the database. Also notifies the appropriate model listeners. 068 * 069 * @param fileShortcutId the primary key of the document library file shortcut 070 * @throws PortalException if a document library file shortcut with the primary key could not be found 071 * @throws SystemException if a system exception occurred 072 */ 073 public void deleteDLFileShortcut(long fileShortcutId) 074 throws com.liferay.portal.kernel.exception.PortalException, 075 com.liferay.portal.kernel.exception.SystemException; 076 077 /** 078 * Deletes the document library file shortcut from the database. Also notifies the appropriate model listeners. 079 * 080 * @param dlFileShortcut the document library file shortcut 081 * @throws SystemException if a system exception occurred 082 */ 083 public void deleteDLFileShortcut( 084 com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut) 085 throws com.liferay.portal.kernel.exception.SystemException; 086 087 /** 088 * Performs a dynamic query on the database and returns the matching rows. 089 * 090 * @param dynamicQuery the dynamic query 091 * @return the matching rows 092 * @throws SystemException if a system exception occurred 093 */ 094 @SuppressWarnings("rawtypes") 095 public java.util.List dynamicQuery( 096 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 097 throws com.liferay.portal.kernel.exception.SystemException; 098 099 /** 100 * Performs a dynamic query on the database and returns a range of the matching rows. 101 * 102 * <p> 103 * 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. 104 * </p> 105 * 106 * @param dynamicQuery the dynamic query 107 * @param start the lower bound of the range of model instances 108 * @param end the upper bound of the range of model instances (not inclusive) 109 * @return the range of matching rows 110 * @throws SystemException if a system exception occurred 111 */ 112 @SuppressWarnings("rawtypes") 113 public java.util.List dynamicQuery( 114 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 115 int end) throws com.liferay.portal.kernel.exception.SystemException; 116 117 /** 118 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 119 * 120 * <p> 121 * 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. 122 * </p> 123 * 124 * @param dynamicQuery the dynamic query 125 * @param start the lower bound of the range of model instances 126 * @param end the upper bound of the range of model instances (not inclusive) 127 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 128 * @return the ordered range of matching rows 129 * @throws SystemException if a system exception occurred 130 */ 131 @SuppressWarnings("rawtypes") 132 public java.util.List dynamicQuery( 133 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 134 int end, 135 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 136 throws com.liferay.portal.kernel.exception.SystemException; 137 138 /** 139 * Returns the number of rows that match the dynamic query. 140 * 141 * @param dynamicQuery the dynamic query 142 * @return the number of rows that match the dynamic query 143 * @throws SystemException if a system exception occurred 144 */ 145 public long dynamicQueryCount( 146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 147 throws com.liferay.portal.kernel.exception.SystemException; 148 149 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 150 public com.liferay.portlet.documentlibrary.model.DLFileShortcut fetchDLFileShortcut( 151 long fileShortcutId) 152 throws com.liferay.portal.kernel.exception.SystemException; 153 154 /** 155 * Returns the document library file shortcut with the primary key. 156 * 157 * @param fileShortcutId the primary key of the document library file shortcut 158 * @return the document library file shortcut 159 * @throws PortalException if a document library file shortcut with the primary key could not be found 160 * @throws SystemException if a system exception occurred 161 */ 162 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 163 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getDLFileShortcut( 164 long fileShortcutId) 165 throws com.liferay.portal.kernel.exception.PortalException, 166 com.liferay.portal.kernel.exception.SystemException; 167 168 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 169 public com.liferay.portal.model.PersistedModel getPersistedModel( 170 java.io.Serializable primaryKeyObj) 171 throws com.liferay.portal.kernel.exception.PortalException, 172 com.liferay.portal.kernel.exception.SystemException; 173 174 /** 175 * Returns the document library file shortcut with the UUID in the group. 176 * 177 * @param uuid the UUID of document library file shortcut 178 * @param groupId the group id of the document library file shortcut 179 * @return the document library file shortcut 180 * @throws PortalException if a document library file shortcut with the UUID in the group could not be found 181 * @throws SystemException if a system exception occurred 182 */ 183 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 184 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getDLFileShortcutByUuidAndGroupId( 185 java.lang.String uuid, long groupId) 186 throws com.liferay.portal.kernel.exception.PortalException, 187 com.liferay.portal.kernel.exception.SystemException; 188 189 /** 190 * Returns a range of all the document library file shortcuts. 191 * 192 * <p> 193 * 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. 194 * </p> 195 * 196 * @param start the lower bound of the range of document library file shortcuts 197 * @param end the upper bound of the range of document library file shortcuts (not inclusive) 198 * @return the range of document library file shortcuts 199 * @throws SystemException if a system exception occurred 200 */ 201 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 202 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileShortcut> getDLFileShortcuts( 203 int start, int end) 204 throws com.liferay.portal.kernel.exception.SystemException; 205 206 /** 207 * Returns the number of document library file shortcuts. 208 * 209 * @return the number of document library file shortcuts 210 * @throws SystemException if a system exception occurred 211 */ 212 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 213 public int getDLFileShortcutsCount() 214 throws com.liferay.portal.kernel.exception.SystemException; 215 216 /** 217 * Updates the document library file shortcut in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 218 * 219 * @param dlFileShortcut the document library file shortcut 220 * @return the document library file shortcut that was updated 221 * @throws SystemException if a system exception occurred 222 */ 223 public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateDLFileShortcut( 224 com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut) 225 throws com.liferay.portal.kernel.exception.SystemException; 226 227 /** 228 * Updates the document library file shortcut in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 229 * 230 * @param dlFileShortcut the document library file shortcut 231 * @param merge whether to merge the document library file shortcut with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation. 232 * @return the document library file shortcut that was updated 233 * @throws SystemException if a system exception occurred 234 */ 235 public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateDLFileShortcut( 236 com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut, 237 boolean merge) 238 throws com.liferay.portal.kernel.exception.SystemException; 239 240 /** 241 * Returns the Spring bean ID for this bean. 242 * 243 * @return the Spring bean ID for this bean 244 */ 245 public java.lang.String getBeanIdentifier(); 246 247 /** 248 * Sets the Spring bean ID for this bean. 249 * 250 * @param beanIdentifier the Spring bean ID for this bean 251 */ 252 public void setBeanIdentifier(java.lang.String beanIdentifier); 253 254 public com.liferay.portlet.documentlibrary.model.DLFileShortcut addFileShortcut( 255 long userId, long groupId, long folderId, long toFileEntryId, 256 com.liferay.portal.service.ServiceContext serviceContext) 257 throws com.liferay.portal.kernel.exception.PortalException, 258 com.liferay.portal.kernel.exception.SystemException; 259 260 public void addFileShortcutResources( 261 com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut, 262 boolean addGroupPermissions, boolean addGuestPermissions) 263 throws com.liferay.portal.kernel.exception.PortalException, 264 com.liferay.portal.kernel.exception.SystemException; 265 266 public void addFileShortcutResources( 267 com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut, 268 java.lang.String[] groupPermissions, java.lang.String[] guestPermissions) 269 throws com.liferay.portal.kernel.exception.PortalException, 270 com.liferay.portal.kernel.exception.SystemException; 271 272 public void addFileShortcutResources(long fileShortcutId, 273 boolean addGroupPermissions, boolean addGuestPermissions) 274 throws com.liferay.portal.kernel.exception.PortalException, 275 com.liferay.portal.kernel.exception.SystemException; 276 277 public void addFileShortcutResources(long fileShortcutId, 278 java.lang.String[] groupPermissions, java.lang.String[] guestPermissions) 279 throws com.liferay.portal.kernel.exception.PortalException, 280 com.liferay.portal.kernel.exception.SystemException; 281 282 public void deleteFileShortcut( 283 com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut) 284 throws com.liferay.portal.kernel.exception.PortalException, 285 com.liferay.portal.kernel.exception.SystemException; 286 287 public void deleteFileShortcut(long fileShortcutId) 288 throws com.liferay.portal.kernel.exception.PortalException, 289 com.liferay.portal.kernel.exception.SystemException; 290 291 public void deleteFileShortcuts(long toFileEntryId) 292 throws com.liferay.portal.kernel.exception.PortalException, 293 com.liferay.portal.kernel.exception.SystemException; 294 295 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 296 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut( 297 long fileShortcutId) 298 throws com.liferay.portal.kernel.exception.PortalException, 299 com.liferay.portal.kernel.exception.SystemException; 300 301 public void updateAsset(long userId, 302 com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut, 303 long[] assetCategoryIds, java.lang.String[] assetTagNames) 304 throws com.liferay.portal.kernel.exception.PortalException, 305 com.liferay.portal.kernel.exception.SystemException; 306 307 public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut( 308 long userId, long fileShortcutId, long folderId, long toFileEntryId, 309 com.liferay.portal.service.ServiceContext serviceContext) 310 throws com.liferay.portal.kernel.exception.PortalException, 311 com.liferay.portal.kernel.exception.SystemException; 312 313 public void updateFileShortcuts(long oldToFileEntryId, long newToFileEntryId) 314 throws com.liferay.portal.kernel.exception.SystemException; 315 }