001 /** 002 * Copyright (c) 2000-present 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 */ 055 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 056 public com.liferay.portal.model.LayoutFriendlyURL addLayoutFriendlyURL( 057 com.liferay.portal.model.LayoutFriendlyURL layoutFriendlyURL); 058 059 public com.liferay.portal.model.LayoutFriendlyURL addLayoutFriendlyURL( 060 long userId, long companyId, long groupId, long plid, 061 boolean privateLayout, java.lang.String friendlyURL, 062 java.lang.String languageId, 063 com.liferay.portal.service.ServiceContext serviceContext) 064 throws com.liferay.portal.kernel.exception.PortalException; 065 066 public java.util.List<com.liferay.portal.model.LayoutFriendlyURL> addLayoutFriendlyURLs( 067 long userId, long companyId, long groupId, long plid, 068 boolean privateLayout, 069 java.util.Map<java.util.Locale, java.lang.String> friendlyURLMap, 070 com.liferay.portal.service.ServiceContext serviceContext) 071 throws com.liferay.portal.kernel.exception.PortalException; 072 073 /** 074 * Creates a new layout friendly u r l with the primary key. Does not add the layout friendly u r l to the database. 075 * 076 * @param layoutFriendlyURLId the primary key for the new layout friendly u r l 077 * @return the new layout friendly u r l 078 */ 079 public com.liferay.portal.model.LayoutFriendlyURL createLayoutFriendlyURL( 080 long layoutFriendlyURLId); 081 082 /** 083 * Deletes the layout friendly u r l from the database. Also notifies the appropriate model listeners. 084 * 085 * @param layoutFriendlyURL the layout friendly u r l 086 * @return the layout friendly u r l that was removed 087 */ 088 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 089 public com.liferay.portal.model.LayoutFriendlyURL deleteLayoutFriendlyURL( 090 com.liferay.portal.model.LayoutFriendlyURL layoutFriendlyURL); 091 092 /** 093 * Deletes the layout friendly u r l with the primary key from the database. Also notifies the appropriate model listeners. 094 * 095 * @param layoutFriendlyURLId the primary key of the layout friendly u r l 096 * @return the layout friendly u r l that was removed 097 * @throws PortalException if a layout friendly u r l with the primary key could not be found 098 */ 099 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 100 public com.liferay.portal.model.LayoutFriendlyURL deleteLayoutFriendlyURL( 101 long layoutFriendlyURLId) 102 throws com.liferay.portal.kernel.exception.PortalException; 103 104 public void deleteLayoutFriendlyURL(long plid, java.lang.String languageId); 105 106 public void deleteLayoutFriendlyURLs(long plid); 107 108 /** 109 * @throws PortalException 110 */ 111 @Override 112 public com.liferay.portal.model.PersistedModel deletePersistedModel( 113 com.liferay.portal.model.PersistedModel persistedModel) 114 throws com.liferay.portal.kernel.exception.PortalException; 115 116 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 117 118 /** 119 * Performs a dynamic query on the database and returns the matching rows. 120 * 121 * @param dynamicQuery the dynamic query 122 * @return the matching rows 123 */ 124 public <T> java.util.List<T> dynamicQuery( 125 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 126 127 /** 128 * Performs a dynamic query on the database and returns a range of the matching rows. 129 * 130 * <p> 131 * 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. 132 * </p> 133 * 134 * @param dynamicQuery the dynamic query 135 * @param start the lower bound of the range of model instances 136 * @param end the upper bound of the range of model instances (not inclusive) 137 * @return the range of matching rows 138 */ 139 public <T> java.util.List<T> dynamicQuery( 140 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 141 int end); 142 143 /** 144 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 145 * 146 * <p> 147 * 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. 148 * </p> 149 * 150 * @param dynamicQuery the dynamic query 151 * @param start the lower bound of the range of model instances 152 * @param end the upper bound of the range of model instances (not inclusive) 153 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 154 * @return the ordered range of matching rows 155 */ 156 public <T> java.util.List<T> dynamicQuery( 157 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 158 int end, 159 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 160 161 /** 162 * Returns the number of rows matching the dynamic query. 163 * 164 * @param dynamicQuery the dynamic query 165 * @return the number of rows matching the dynamic query 166 */ 167 public long dynamicQueryCount( 168 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 169 170 /** 171 * Returns the number of rows matching the dynamic query. 172 * 173 * @param dynamicQuery the dynamic query 174 * @param projection the projection to apply to the query 175 * @return the number of rows matching the dynamic query 176 */ 177 public long dynamicQueryCount( 178 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 179 com.liferay.portal.kernel.dao.orm.Projection projection); 180 181 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 182 public com.liferay.portal.model.LayoutFriendlyURL fetchFirstLayoutFriendlyURL( 183 long groupId, boolean privateLayout, java.lang.String friendlyURL); 184 185 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 186 public com.liferay.portal.model.LayoutFriendlyURL fetchLayoutFriendlyURL( 187 long groupId, boolean privateLayout, java.lang.String friendlyURL, 188 java.lang.String languageId); 189 190 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 191 public com.liferay.portal.model.LayoutFriendlyURL fetchLayoutFriendlyURL( 192 long layoutFriendlyURLId); 193 194 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 195 public com.liferay.portal.model.LayoutFriendlyURL fetchLayoutFriendlyURL( 196 long plid, java.lang.String languageId); 197 198 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 199 public com.liferay.portal.model.LayoutFriendlyURL fetchLayoutFriendlyURL( 200 long plid, java.lang.String languageId, boolean useDefault); 201 202 /** 203 * Returns the layout friendly u r l matching the UUID and group. 204 * 205 * @param uuid the layout friendly u r l's UUID 206 * @param groupId the primary key of the group 207 * @return the matching layout friendly u r l, or <code>null</code> if a matching layout friendly u r l could not be found 208 */ 209 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 210 public com.liferay.portal.model.LayoutFriendlyURL fetchLayoutFriendlyURLByUuidAndGroupId( 211 java.lang.String uuid, long groupId); 212 213 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 214 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 215 216 /** 217 * Returns the Spring bean ID for this bean. 218 * 219 * @return the Spring bean ID for this bean 220 */ 221 public java.lang.String getBeanIdentifier(); 222 223 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 224 public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery( 225 com.liferay.portal.kernel.lar.PortletDataContext portletDataContext); 226 227 /** 228 * Returns the layout friendly u r l with the primary key. 229 * 230 * @param layoutFriendlyURLId the primary key of the layout friendly u r l 231 * @return the layout friendly u r l 232 * @throws PortalException if a layout friendly u r l with the primary key could not be found 233 */ 234 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 235 public com.liferay.portal.model.LayoutFriendlyURL getLayoutFriendlyURL( 236 long layoutFriendlyURLId) 237 throws com.liferay.portal.kernel.exception.PortalException; 238 239 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 240 public com.liferay.portal.model.LayoutFriendlyURL getLayoutFriendlyURL( 241 long plid, java.lang.String languageId) 242 throws com.liferay.portal.kernel.exception.PortalException; 243 244 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 245 public com.liferay.portal.model.LayoutFriendlyURL getLayoutFriendlyURL( 246 long plid, java.lang.String languageId, boolean useDefault) 247 throws com.liferay.portal.kernel.exception.PortalException; 248 249 /** 250 * Returns the layout friendly u r l matching the UUID and group. 251 * 252 * @param uuid the layout friendly u r l's UUID 253 * @param groupId the primary key of the group 254 * @return the matching layout friendly u r l 255 * @throws PortalException if a matching layout friendly u r l could not be found 256 */ 257 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 258 public com.liferay.portal.model.LayoutFriendlyURL getLayoutFriendlyURLByUuidAndGroupId( 259 java.lang.String uuid, long groupId) 260 throws com.liferay.portal.kernel.exception.PortalException; 261 262 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 263 public java.util.List<com.liferay.portal.model.LayoutFriendlyURL> getLayoutFriendlyURLs( 264 long plid); 265 266 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 267 public java.util.List<com.liferay.portal.model.LayoutFriendlyURL> getLayoutFriendlyURLs( 268 long plid, java.lang.String friendlyURL, int start, int end); 269 270 /** 271 * Returns a range of all the layout friendly u r ls. 272 * 273 * <p> 274 * 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. 275 * </p> 276 * 277 * @param start the lower bound of the range of layout friendly u r ls 278 * @param end the upper bound of the range of layout friendly u r ls (not inclusive) 279 * @return the range of layout friendly u r ls 280 */ 281 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 282 public java.util.List<com.liferay.portal.model.LayoutFriendlyURL> getLayoutFriendlyURLs( 283 int start, int end); 284 285 /** 286 * Returns all the layout friendly u r ls matching the UUID and company. 287 * 288 * @param uuid the UUID of the layout friendly u r ls 289 * @param companyId the primary key of the company 290 * @return the matching layout friendly u r ls, or an empty list if no matches were found 291 */ 292 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 293 public java.util.List<com.liferay.portal.model.LayoutFriendlyURL> getLayoutFriendlyURLsByUuidAndCompanyId( 294 java.lang.String uuid, long companyId); 295 296 /** 297 * Returns a range of layout friendly u r ls matching the UUID and company. 298 * 299 * @param uuid the UUID of the layout friendly u r ls 300 * @param companyId the primary key of the company 301 * @param start the lower bound of the range of layout friendly u r ls 302 * @param end the upper bound of the range of layout friendly u r ls (not inclusive) 303 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 304 * @return the range of matching layout friendly u r ls, or an empty list if no matches were found 305 */ 306 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 307 public java.util.List<com.liferay.portal.model.LayoutFriendlyURL> getLayoutFriendlyURLsByUuidAndCompanyId( 308 java.lang.String uuid, long companyId, int start, int end, 309 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.LayoutFriendlyURL> orderByComparator); 310 311 /** 312 * Returns the number of layout friendly u r ls. 313 * 314 * @return the number of layout friendly u r ls 315 */ 316 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 317 public int getLayoutFriendlyURLsCount(); 318 319 @Override 320 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 321 public com.liferay.portal.model.PersistedModel getPersistedModel( 322 java.io.Serializable primaryKeyObj) 323 throws com.liferay.portal.kernel.exception.PortalException; 324 325 /** 326 * Sets the Spring bean ID for this bean. 327 * 328 * @param beanIdentifier the Spring bean ID for this bean 329 */ 330 public void setBeanIdentifier(java.lang.String beanIdentifier); 331 332 /** 333 * 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. 334 * 335 * @param layoutFriendlyURL the layout friendly u r l 336 * @return the layout friendly u r l that was updated 337 */ 338 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 339 public com.liferay.portal.model.LayoutFriendlyURL updateLayoutFriendlyURL( 340 com.liferay.portal.model.LayoutFriendlyURL layoutFriendlyURL); 341 342 public com.liferay.portal.model.LayoutFriendlyURL updateLayoutFriendlyURL( 343 long userId, long companyId, long groupId, long plid, 344 boolean privateLayout, java.lang.String friendlyURL, 345 java.lang.String languageId, 346 com.liferay.portal.service.ServiceContext serviceContext) 347 throws com.liferay.portal.kernel.exception.PortalException; 348 349 public java.util.List<com.liferay.portal.model.LayoutFriendlyURL> updateLayoutFriendlyURLs( 350 long userId, long companyId, long groupId, long plid, 351 boolean privateLayout, 352 java.util.Map<java.util.Locale, java.lang.String> friendlyURLMap, 353 com.liferay.portal.service.ServiceContext serviceContext) 354 throws com.liferay.portal.kernel.exception.PortalException; 355 }