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