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