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