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 LayoutSet. 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 LayoutSetLocalServiceUtil
033     * @see com.liferay.portal.service.base.LayoutSetLocalServiceBaseImpl
034     * @see com.liferay.portal.service.impl.LayoutSetLocalServiceImpl
035     * @generated
036     */
037    @ProviderType
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface LayoutSetLocalService extends BaseLocalService,
041            PersistedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * Never modify or reference this interface directly. Always use {@link LayoutSetLocalServiceUtil} to access the layout set local service. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutSetLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
046             */
047    
048            /**
049            * Adds the layout set to the database. Also notifies the appropriate model listeners.
050            *
051            * @param layoutSet the layout set
052            * @return the layout set that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portal.model.LayoutSet addLayoutSet(
056                    com.liferay.portal.model.LayoutSet layoutSet)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new layout set with the primary key. Does not add the layout set to the database.
061            *
062            * @param layoutSetId the primary key for the new layout set
063            * @return the new layout set
064            */
065            public com.liferay.portal.model.LayoutSet createLayoutSet(long layoutSetId);
066    
067            /**
068            * Deletes the layout set with the primary key from the database. Also notifies the appropriate model listeners.
069            *
070            * @param layoutSetId the primary key of the layout set
071            * @return the layout set that was removed
072            * @throws PortalException if a layout set with the primary key could not be found
073            * @throws SystemException if a system exception occurred
074            */
075            public com.liferay.portal.model.LayoutSet deleteLayoutSet(long layoutSetId)
076                    throws com.liferay.portal.kernel.exception.PortalException,
077                            com.liferay.portal.kernel.exception.SystemException;
078    
079            /**
080            * Deletes the layout set from the database. Also notifies the appropriate model listeners.
081            *
082            * @param layoutSet the layout set
083            * @return the layout set that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public com.liferay.portal.model.LayoutSet deleteLayoutSet(
087                    com.liferay.portal.model.LayoutSet layoutSet)
088                    throws com.liferay.portal.kernel.exception.SystemException;
089    
090            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
091    
092            /**
093            * Performs a dynamic query on the database and returns the matching rows.
094            *
095            * @param dynamicQuery the dynamic query
096            * @return the matching rows
097            * @throws SystemException if a system exception occurred
098            */
099            @SuppressWarnings("rawtypes")
100            public java.util.List dynamicQuery(
101                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
102                    throws com.liferay.portal.kernel.exception.SystemException;
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * 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.LayoutSetModelImpl}. 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.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException;
121    
122            /**
123            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
124            *
125            * <p>
126            * 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.LayoutSetModelImpl}. 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.
127            * </p>
128            *
129            * @param dynamicQuery the dynamic query
130            * @param start the lower bound of the range of model instances
131            * @param end the upper bound of the range of model instances (not inclusive)
132            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
133            * @return the ordered range of matching rows
134            * @throws SystemException if a system exception occurred
135            */
136            @SuppressWarnings("rawtypes")
137            public java.util.List dynamicQuery(
138                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
139                    int end,
140                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
141                    throws com.liferay.portal.kernel.exception.SystemException;
142    
143            /**
144            * Returns the number of rows that match the dynamic query.
145            *
146            * @param dynamicQuery the dynamic query
147            * @return the number of rows that match the dynamic query
148            * @throws SystemException if a system exception occurred
149            */
150            public long dynamicQueryCount(
151                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
152                    throws com.liferay.portal.kernel.exception.SystemException;
153    
154            /**
155            * Returns the number of rows that match the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @param projection the projection to apply to the query
159            * @return the number of rows that match the dynamic query
160            * @throws SystemException if a system exception occurred
161            */
162            public long dynamicQueryCount(
163                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
164                    com.liferay.portal.kernel.dao.orm.Projection projection)
165                    throws com.liferay.portal.kernel.exception.SystemException;
166    
167            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
168            public com.liferay.portal.model.LayoutSet fetchLayoutSet(long layoutSetId)
169                    throws com.liferay.portal.kernel.exception.SystemException;
170    
171            /**
172            * Returns the layout set with the primary key.
173            *
174            * @param layoutSetId the primary key of the layout set
175            * @return the layout set
176            * @throws PortalException if a layout set with the primary key 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.LayoutSet getLayoutSet(long layoutSetId)
181                    throws com.liferay.portal.kernel.exception.PortalException,
182                            com.liferay.portal.kernel.exception.SystemException;
183    
184            @Override
185            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
186            public com.liferay.portal.model.PersistedModel getPersistedModel(
187                    java.io.Serializable primaryKeyObj)
188                    throws com.liferay.portal.kernel.exception.PortalException,
189                            com.liferay.portal.kernel.exception.SystemException;
190    
191            /**
192            * Returns a range of all the layout sets.
193            *
194            * <p>
195            * 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.LayoutSetModelImpl}. 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.
196            * </p>
197            *
198            * @param start the lower bound of the range of layout sets
199            * @param end the upper bound of the range of layout sets (not inclusive)
200            * @return the range of layout sets
201            * @throws SystemException if a system exception occurred
202            */
203            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
204            public java.util.List<com.liferay.portal.model.LayoutSet> getLayoutSets(
205                    int start, int end)
206                    throws com.liferay.portal.kernel.exception.SystemException;
207    
208            /**
209            * Returns the number of layout sets.
210            *
211            * @return the number of layout sets
212            * @throws SystemException if a system exception occurred
213            */
214            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
215            public int getLayoutSetsCount()
216                    throws com.liferay.portal.kernel.exception.SystemException;
217    
218            /**
219            * Updates the layout set in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
220            *
221            * @param layoutSet the layout set
222            * @return the layout set that was updated
223            * @throws SystemException if a system exception occurred
224            */
225            public com.liferay.portal.model.LayoutSet updateLayoutSet(
226                    com.liferay.portal.model.LayoutSet layoutSet)
227                    throws com.liferay.portal.kernel.exception.SystemException;
228    
229            /**
230            * Returns the Spring bean ID for this bean.
231            *
232            * @return the Spring bean ID for this bean
233            */
234            public java.lang.String getBeanIdentifier();
235    
236            /**
237            * Sets the Spring bean ID for this bean.
238            *
239            * @param beanIdentifier the Spring bean ID for this bean
240            */
241            public void setBeanIdentifier(java.lang.String beanIdentifier);
242    
243            public com.liferay.portal.model.LayoutSet addLayoutSet(long groupId,
244                    boolean privateLayout)
245                    throws com.liferay.portal.kernel.exception.PortalException,
246                            com.liferay.portal.kernel.exception.SystemException;
247    
248            public void deleteLayoutSet(long groupId, boolean privateLayout,
249                    com.liferay.portal.service.ServiceContext serviceContext)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException;
252    
253            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
254            public com.liferay.portal.model.LayoutSet fetchLayoutSet(
255                    java.lang.String virtualHostname)
256                    throws com.liferay.portal.kernel.exception.SystemException;
257    
258            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
259            public com.liferay.portal.model.LayoutSet getLayoutSet(long groupId,
260                    boolean privateLayout)
261                    throws com.liferay.portal.kernel.exception.PortalException,
262                            com.liferay.portal.kernel.exception.SystemException;
263    
264            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
265            public com.liferay.portal.model.LayoutSet getLayoutSet(
266                    java.lang.String virtualHostname)
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.portal.model.LayoutSet> getLayoutSetsByLayoutSetPrototypeUuid(
272                    java.lang.String layoutSetPrototypeUuid)
273                    throws com.liferay.portal.kernel.exception.SystemException;
274    
275            /**
276            * Updates the state of the layout set prototype link.
277            *
278            * <p>
279            * This method can disable the layout set prototype's link by setting
280            * <code>layoutSetPrototypeLinkEnabled</code> to <code>false</code>.
281            * However, this method can only enable the layout set prototype's link if
282            * the layout set prototype's current uuid is not <code>null</code>. Setting
283            * the <code>layoutSetPrototypeLinkEnabled</code> to <code>true</code> when
284            * the layout set prototype's current uuid is <code>null</code> will have no
285            * effect.
286            * </p>
287            *
288            * @param groupId the primary key of the group
289            * @param privateLayout whether the layout set is private to the group
290            * @param layoutSetPrototypeLinkEnabled whether the layout set
291            prototype is link enabled
292            * @throws PortalException if a portal exception occurred
293            * @throws SystemException if a system exception occurred
294            * @deprecated As of 6.1.0, replaced by {@link
295            #updateLayoutSetPrototypeLinkEnabled(long, boolean, boolean,
296            String)}
297            */
298            public void updateLayoutSetPrototypeLinkEnabled(long groupId,
299                    boolean privateLayout, boolean layoutSetPrototypeLinkEnabled)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException;
302    
303            /**
304            * Updates the state of the layout set prototype link.
305            *
306            * @param groupId the primary key of the group
307            * @param privateLayout whether the layout set is private to the group
308            * @param layoutSetPrototypeLinkEnabled whether the layout set prototype is
309            link enabled
310            * @param layoutSetPrototypeUuid the uuid of the layout set prototype to
311            link with
312            * @throws PortalException if a portal exception occurred
313            * @throws SystemException if a system exception occurred
314            */
315            public void updateLayoutSetPrototypeLinkEnabled(long groupId,
316                    boolean privateLayout, boolean layoutSetPrototypeLinkEnabled,
317                    java.lang.String layoutSetPrototypeUuid)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException;
320    
321            public com.liferay.portal.model.LayoutSet updateLogo(long groupId,
322                    boolean privateLayout, boolean logo, byte[] bytes)
323                    throws com.liferay.portal.kernel.exception.PortalException,
324                            com.liferay.portal.kernel.exception.SystemException;
325    
326            public com.liferay.portal.model.LayoutSet updateLogo(long groupId,
327                    boolean privateLayout, boolean logo, java.io.File file)
328                    throws com.liferay.portal.kernel.exception.PortalException,
329                            com.liferay.portal.kernel.exception.SystemException;
330    
331            public com.liferay.portal.model.LayoutSet updateLogo(long groupId,
332                    boolean privateLayout, boolean logo, java.io.InputStream is)
333                    throws com.liferay.portal.kernel.exception.PortalException,
334                            com.liferay.portal.kernel.exception.SystemException;
335    
336            public com.liferay.portal.model.LayoutSet updateLogo(long groupId,
337                    boolean privateLayout, boolean logo, java.io.InputStream is,
338                    boolean cleanUpStream)
339                    throws com.liferay.portal.kernel.exception.PortalException,
340                            com.liferay.portal.kernel.exception.SystemException;
341    
342            public com.liferay.portal.model.LayoutSet updateLookAndFeel(long groupId,
343                    boolean privateLayout, java.lang.String themeId,
344                    java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
345                    throws com.liferay.portal.kernel.exception.PortalException,
346                            com.liferay.portal.kernel.exception.SystemException;
347    
348            public void updateLookAndFeel(long groupId, java.lang.String themeId,
349                    java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
350                    throws com.liferay.portal.kernel.exception.PortalException,
351                            com.liferay.portal.kernel.exception.SystemException;
352    
353            public com.liferay.portal.model.LayoutSet updatePageCount(long groupId,
354                    boolean privateLayout)
355                    throws com.liferay.portal.kernel.exception.PortalException,
356                            com.liferay.portal.kernel.exception.SystemException;
357    
358            public com.liferay.portal.model.LayoutSet updateSettings(long groupId,
359                    boolean privateLayout, java.lang.String settings)
360                    throws com.liferay.portal.kernel.exception.PortalException,
361                            com.liferay.portal.kernel.exception.SystemException;
362    
363            public com.liferay.portal.model.LayoutSet updateVirtualHost(long groupId,
364                    boolean privateLayout, java.lang.String virtualHostname)
365                    throws com.liferay.portal.kernel.exception.PortalException,
366                            com.liferay.portal.kernel.exception.SystemException;
367    }