001 /** 002 * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved. 003 * 004 * The contents of this file are subject to the terms of the Liferay Enterprise 005 * Subscription License ("License"). You may not use this file except in 006 * compliance with the License. You can obtain a copy of the License by 007 * contacting Liferay, Inc. See the License for the specific language governing 008 * permissions and limitations under the License, including but not limited to 009 * distribution rights of the Software. 010 * 011 * 012 * 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 d l 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 d l 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 d l file shortcut to the database. Also notifies the appropriate model listeners. 048 * 049 * @param dlFileShortcut the d l file shortcut 050 * @return the d l 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 d l file shortcut with the primary key. Does not add the d l file shortcut to the database. 059 * 060 * @param fileShortcutId the primary key for the new d l file shortcut 061 * @return the new d l file shortcut 062 */ 063 public com.liferay.portlet.documentlibrary.model.DLFileShortcut createDLFileShortcut( 064 long fileShortcutId); 065 066 /** 067 * Deletes the d l file shortcut with the primary key from the database. Also notifies the appropriate model listeners. 068 * 069 * @param fileShortcutId the primary key of the d l file shortcut 070 * @throws PortalException if a d l 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 d l file shortcut from the database. Also notifies the appropriate model listeners. 079 * 080 * @param dlFileShortcut the d l 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 /** 150 * Returns the d l file shortcut with the primary key. 151 * 152 * @param fileShortcutId the primary key of the d l file shortcut 153 * @return the d l file shortcut 154 * @throws PortalException if a d l file shortcut with the primary key could not be found 155 * @throws SystemException if a system exception occurred 156 */ 157 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 158 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getDLFileShortcut( 159 long fileShortcutId) 160 throws com.liferay.portal.kernel.exception.PortalException, 161 com.liferay.portal.kernel.exception.SystemException; 162 163 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 164 public com.liferay.portal.model.PersistedModel getPersistedModel( 165 java.io.Serializable primaryKeyObj) 166 throws com.liferay.portal.kernel.exception.PortalException, 167 com.liferay.portal.kernel.exception.SystemException; 168 169 /** 170 * Returns the d l file shortcut with the UUID in the group. 171 * 172 * @param uuid the UUID of d l file shortcut 173 * @param groupId the group id of the d l file shortcut 174 * @return the d l file shortcut 175 * @throws PortalException if a d l file shortcut with the UUID in the group could not be found 176 * @throws SystemException if a system exception occurred 177 */ 178 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 179 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getDLFileShortcutByUuidAndGroupId( 180 java.lang.String uuid, long groupId) 181 throws com.liferay.portal.kernel.exception.PortalException, 182 com.liferay.portal.kernel.exception.SystemException; 183 184 /** 185 * Returns a range of all the d l file shortcuts. 186 * 187 * <p> 188 * 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. 189 * </p> 190 * 191 * @param start the lower bound of the range of d l file shortcuts 192 * @param end the upper bound of the range of d l file shortcuts (not inclusive) 193 * @return the range of d l file shortcuts 194 * @throws SystemException if a system exception occurred 195 */ 196 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 197 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileShortcut> getDLFileShortcuts( 198 int start, int end) 199 throws com.liferay.portal.kernel.exception.SystemException; 200 201 /** 202 * Returns the number of d l file shortcuts. 203 * 204 * @return the number of d l file shortcuts 205 * @throws SystemException if a system exception occurred 206 */ 207 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 208 public int getDLFileShortcutsCount() 209 throws com.liferay.portal.kernel.exception.SystemException; 210 211 /** 212 * Updates the d l file shortcut in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 213 * 214 * @param dlFileShortcut the d l file shortcut 215 * @return the d l file shortcut that was updated 216 * @throws SystemException if a system exception occurred 217 */ 218 public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateDLFileShortcut( 219 com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut) 220 throws com.liferay.portal.kernel.exception.SystemException; 221 222 /** 223 * Updates the d l file shortcut in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 224 * 225 * @param dlFileShortcut the d l file shortcut 226 * @param merge whether to merge the d l 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. 227 * @return the d l file shortcut that was updated 228 * @throws SystemException if a system exception occurred 229 */ 230 public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateDLFileShortcut( 231 com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut, 232 boolean merge) 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.DLFileShortcut addFileShortcut( 250 long userId, long groupId, long folderId, long toFileEntryId, 251 com.liferay.portal.service.ServiceContext serviceContext) 252 throws com.liferay.portal.kernel.exception.PortalException, 253 com.liferay.portal.kernel.exception.SystemException; 254 255 public void addFileShortcutResources( 256 com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut, 257 boolean addCommunityPermissions, boolean addGuestPermissions) 258 throws com.liferay.portal.kernel.exception.PortalException, 259 com.liferay.portal.kernel.exception.SystemException; 260 261 public void addFileShortcutResources( 262 com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut, 263 java.lang.String[] communityPermissions, 264 java.lang.String[] guestPermissions) 265 throws com.liferay.portal.kernel.exception.PortalException, 266 com.liferay.portal.kernel.exception.SystemException; 267 268 public void addFileShortcutResources(long fileShortcutId, 269 boolean addCommunityPermissions, boolean addGuestPermissions) 270 throws com.liferay.portal.kernel.exception.PortalException, 271 com.liferay.portal.kernel.exception.SystemException; 272 273 public void addFileShortcutResources(long fileShortcutId, 274 java.lang.String[] communityPermissions, 275 java.lang.String[] guestPermissions) 276 throws com.liferay.portal.kernel.exception.PortalException, 277 com.liferay.portal.kernel.exception.SystemException; 278 279 public void deleteFileShortcut( 280 com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut) 281 throws com.liferay.portal.kernel.exception.PortalException, 282 com.liferay.portal.kernel.exception.SystemException; 283 284 public void deleteFileShortcut(long fileShortcutId) 285 throws com.liferay.portal.kernel.exception.PortalException, 286 com.liferay.portal.kernel.exception.SystemException; 287 288 public void deleteFileShortcuts(long toFileEntryId) 289 throws com.liferay.portal.kernel.exception.PortalException, 290 com.liferay.portal.kernel.exception.SystemException; 291 292 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 293 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut( 294 long fileShortcutId) 295 throws com.liferay.portal.kernel.exception.PortalException, 296 com.liferay.portal.kernel.exception.SystemException; 297 298 public void updateAsset(long userId, 299 com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut, 300 long[] assetCategoryIds, java.lang.String[] assetTagNames) 301 throws com.liferay.portal.kernel.exception.PortalException, 302 com.liferay.portal.kernel.exception.SystemException; 303 304 public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut( 305 long userId, long fileShortcutId, long folderId, long toFileEntryId, 306 com.liferay.portal.service.ServiceContext serviceContext) 307 throws com.liferay.portal.kernel.exception.PortalException, 308 com.liferay.portal.kernel.exception.SystemException; 309 310 public void updateFileShortcuts(long oldToFileEntryId, long newToFileEntryId) 311 throws com.liferay.portal.kernel.exception.SystemException; 312 }