001 /** 002 * Copyright (c) 2000-2011 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.bookmarks.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.PermissionedModelLocalService; 023 024 /** 025 * The interface for the bookmarks folder 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 BookmarksFolderLocalServiceUtil 033 * @see com.liferay.portlet.bookmarks.service.base.BookmarksFolderLocalServiceBaseImpl 034 * @see com.liferay.portlet.bookmarks.service.impl.BookmarksFolderLocalServiceImpl 035 * @generated 036 */ 037 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 038 PortalException.class, SystemException.class}) 039 public interface BookmarksFolderLocalService 040 extends PermissionedModelLocalService { 041 /* 042 * NOTE FOR DEVELOPERS: 043 * 044 * Never modify or reference this interface directly. Always use {@link BookmarksFolderLocalServiceUtil} to access the bookmarks folder local service. Add custom service methods to {@link com.liferay.portlet.bookmarks.service.impl.BookmarksFolderLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 045 */ 046 047 /** 048 * Adds the bookmarks folder to the database. Also notifies the appropriate model listeners. 049 * 050 * @param bookmarksFolder the bookmarks folder 051 * @return the bookmarks folder that was added 052 * @throws SystemException if a system exception occurred 053 */ 054 public com.liferay.portlet.bookmarks.model.BookmarksFolder addBookmarksFolder( 055 com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder) 056 throws com.liferay.portal.kernel.exception.SystemException; 057 058 /** 059 * Creates a new bookmarks folder with the primary key. Does not add the bookmarks folder to the database. 060 * 061 * @param folderId the primary key for the new bookmarks folder 062 * @return the new bookmarks folder 063 */ 064 public com.liferay.portlet.bookmarks.model.BookmarksFolder createBookmarksFolder( 065 long folderId); 066 067 /** 068 * Deletes the bookmarks folder with the primary key from the database. Also notifies the appropriate model listeners. 069 * 070 * @param folderId the primary key of the bookmarks folder 071 * @throws PortalException if a bookmarks folder with the primary key could not be found 072 * @throws SystemException if a system exception occurred 073 */ 074 public void deleteBookmarksFolder(long folderId) 075 throws com.liferay.portal.kernel.exception.PortalException, 076 com.liferay.portal.kernel.exception.SystemException; 077 078 /** 079 * Deletes the bookmarks folder from the database. Also notifies the appropriate model listeners. 080 * 081 * @param bookmarksFolder the bookmarks folder 082 * @throws SystemException if a system exception occurred 083 */ 084 public void deleteBookmarksFolder( 085 com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder) 086 throws com.liferay.portal.kernel.exception.SystemException; 087 088 /** 089 * Performs a dynamic query on the database and returns the matching rows. 090 * 091 * @param dynamicQuery the dynamic query 092 * @return the matching rows 093 * @throws SystemException if a system exception occurred 094 */ 095 @SuppressWarnings("rawtypes") 096 public java.util.List dynamicQuery( 097 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 098 throws com.liferay.portal.kernel.exception.SystemException; 099 100 /** 101 * Performs a dynamic query on the database and returns a range of the matching rows. 102 * 103 * <p> 104 * 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. 105 * </p> 106 * 107 * @param dynamicQuery the dynamic query 108 * @param start the lower bound of the range of model instances 109 * @param end the upper bound of the range of model instances (not inclusive) 110 * @return the range of matching rows 111 * @throws SystemException if a system exception occurred 112 */ 113 @SuppressWarnings("rawtypes") 114 public java.util.List dynamicQuery( 115 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 116 int end) throws com.liferay.portal.kernel.exception.SystemException; 117 118 /** 119 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 120 * 121 * <p> 122 * 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. 123 * </p> 124 * 125 * @param dynamicQuery the dynamic query 126 * @param start the lower bound of the range of model instances 127 * @param end the upper bound of the range of model instances (not inclusive) 128 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 129 * @return the ordered range of matching rows 130 * @throws SystemException if a system exception occurred 131 */ 132 @SuppressWarnings("rawtypes") 133 public java.util.List dynamicQuery( 134 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 135 int end, 136 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 137 throws com.liferay.portal.kernel.exception.SystemException; 138 139 /** 140 * Returns the number of rows that match the dynamic query. 141 * 142 * @param dynamicQuery the dynamic query 143 * @return the number of rows that match the dynamic query 144 * @throws SystemException if a system exception occurred 145 */ 146 public long dynamicQueryCount( 147 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 148 throws com.liferay.portal.kernel.exception.SystemException; 149 150 /** 151 * Returns the bookmarks folder with the primary key. 152 * 153 * @param folderId the primary key of the bookmarks folder 154 * @return the bookmarks folder 155 * @throws PortalException if a bookmarks folder with the primary key could not be found 156 * @throws SystemException if a system exception occurred 157 */ 158 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 159 public com.liferay.portlet.bookmarks.model.BookmarksFolder getBookmarksFolder( 160 long folderId) 161 throws com.liferay.portal.kernel.exception.PortalException, 162 com.liferay.portal.kernel.exception.SystemException; 163 164 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 165 public com.liferay.portal.model.PersistedModel getPersistedModel( 166 java.io.Serializable primaryKeyObj) 167 throws com.liferay.portal.kernel.exception.PortalException, 168 com.liferay.portal.kernel.exception.SystemException; 169 170 /** 171 * Returns the bookmarks folder with the UUID in the group. 172 * 173 * @param uuid the UUID of bookmarks folder 174 * @param groupId the group id of the bookmarks folder 175 * @return the bookmarks folder 176 * @throws PortalException if a bookmarks folder with the UUID in the group could not be found 177 * @throws SystemException if a system exception occurred 178 */ 179 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 180 public com.liferay.portlet.bookmarks.model.BookmarksFolder getBookmarksFolderByUuidAndGroupId( 181 java.lang.String uuid, long groupId) 182 throws com.liferay.portal.kernel.exception.PortalException, 183 com.liferay.portal.kernel.exception.SystemException; 184 185 /** 186 * Returns a range of all the bookmarks folders. 187 * 188 * <p> 189 * 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. 190 * </p> 191 * 192 * @param start the lower bound of the range of bookmarks folders 193 * @param end the upper bound of the range of bookmarks folders (not inclusive) 194 * @return the range of bookmarks folders 195 * @throws SystemException if a system exception occurred 196 */ 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getBookmarksFolders( 199 int start, int end) 200 throws com.liferay.portal.kernel.exception.SystemException; 201 202 /** 203 * Returns the number of bookmarks folders. 204 * 205 * @return the number of bookmarks folders 206 * @throws SystemException if a system exception occurred 207 */ 208 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 209 public int getBookmarksFoldersCount() 210 throws com.liferay.portal.kernel.exception.SystemException; 211 212 /** 213 * Updates the bookmarks folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 214 * 215 * @param bookmarksFolder the bookmarks folder 216 * @return the bookmarks folder that was updated 217 * @throws SystemException if a system exception occurred 218 */ 219 public com.liferay.portlet.bookmarks.model.BookmarksFolder updateBookmarksFolder( 220 com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder) 221 throws com.liferay.portal.kernel.exception.SystemException; 222 223 /** 224 * Updates the bookmarks folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 225 * 226 * @param bookmarksFolder the bookmarks folder 227 * @param merge whether to merge the bookmarks folder 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. 228 * @return the bookmarks folder that was updated 229 * @throws SystemException if a system exception occurred 230 */ 231 public com.liferay.portlet.bookmarks.model.BookmarksFolder updateBookmarksFolder( 232 com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder, 233 boolean merge) 234 throws com.liferay.portal.kernel.exception.SystemException; 235 236 /** 237 * Returns the Spring bean ID for this bean. 238 * 239 * @return the Spring bean ID for this bean 240 */ 241 public java.lang.String getBeanIdentifier(); 242 243 /** 244 * Sets the Spring bean ID for this bean. 245 * 246 * @param beanIdentifier the Spring bean ID for this bean 247 */ 248 public void setBeanIdentifier(java.lang.String beanIdentifier); 249 250 public com.liferay.portlet.bookmarks.model.BookmarksFolder addFolder( 251 long userId, long parentFolderId, java.lang.String name, 252 java.lang.String description, 253 com.liferay.portal.service.ServiceContext serviceContext) 254 throws com.liferay.portal.kernel.exception.PortalException, 255 com.liferay.portal.kernel.exception.SystemException; 256 257 public void deleteFolder( 258 com.liferay.portlet.bookmarks.model.BookmarksFolder folder) 259 throws com.liferay.portal.kernel.exception.PortalException, 260 com.liferay.portal.kernel.exception.SystemException; 261 262 public void deleteFolder(long folderId) 263 throws com.liferay.portal.kernel.exception.PortalException, 264 com.liferay.portal.kernel.exception.SystemException; 265 266 public void deleteFolders(long groupId) 267 throws com.liferay.portal.kernel.exception.PortalException, 268 com.liferay.portal.kernel.exception.SystemException; 269 270 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 271 public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getCompanyFolders( 272 long companyId, int start, int end) 273 throws com.liferay.portal.kernel.exception.SystemException; 274 275 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 276 public int getCompanyFoldersCount(long companyId) 277 throws com.liferay.portal.kernel.exception.SystemException; 278 279 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 280 public com.liferay.portlet.bookmarks.model.BookmarksFolder getFolder( 281 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.bookmarks.model.BookmarksFolder> getFolders( 287 long groupId) 288 throws com.liferay.portal.kernel.exception.SystemException; 289 290 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 291 public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders( 292 long groupId, long parentFolderId) 293 throws com.liferay.portal.kernel.exception.SystemException; 294 295 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 296 public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders( 297 long groupId, long parentFolderId, int start, int end) 298 throws com.liferay.portal.kernel.exception.SystemException; 299 300 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 301 public int getFoldersCount(long groupId, long parentFolderId) 302 throws com.liferay.portal.kernel.exception.SystemException; 303 304 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 305 public void getSubfolderIds(java.util.List<java.lang.Long> folderIds, 306 long groupId, long folderId) 307 throws com.liferay.portal.kernel.exception.SystemException; 308 309 public com.liferay.portlet.bookmarks.model.BookmarksFolder updateFolder( 310 long folderId, long parentFolderId, java.lang.String name, 311 java.lang.String description, boolean mergeWithParentFolder, 312 com.liferay.portal.service.ServiceContext serviceContext) 313 throws com.liferay.portal.kernel.exception.PortalException, 314 com.liferay.portal.kernel.exception.SystemException; 315 }