001    /**
002     * Copyright (c) 2000-2012 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     * The interface for the layout set prototype local service.
025     *
026     * <p>
027     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see LayoutSetPrototypeLocalServiceUtil
032     * @see com.liferay.portal.service.base.LayoutSetPrototypeLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.LayoutSetPrototypeLocalServiceImpl
034     * @generated
035     */
036    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
037            PortalException.class, SystemException.class})
038    public interface LayoutSetPrototypeLocalService
039            extends PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify or reference this interface directly. Always use {@link LayoutSetPrototypeLocalServiceUtil} to access the layout set prototype local service. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutSetPrototypeLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
044             */
045    
046            /**
047            * Adds the layout set prototype to the database. Also notifies the appropriate model listeners.
048            *
049            * @param layoutSetPrototype the layout set prototype
050            * @return the layout set prototype that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portal.model.LayoutSetPrototype addLayoutSetPrototype(
054                    com.liferay.portal.model.LayoutSetPrototype layoutSetPrototype)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new layout set prototype with the primary key. Does not add the layout set prototype to the database.
059            *
060            * @param layoutSetPrototypeId the primary key for the new layout set prototype
061            * @return the new layout set prototype
062            */
063            public com.liferay.portal.model.LayoutSetPrototype createLayoutSetPrototype(
064                    long layoutSetPrototypeId);
065    
066            /**
067            * Deletes the layout set prototype with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param layoutSetPrototypeId the primary key of the layout set prototype
070            * @throws PortalException if a layout set prototype with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public void deleteLayoutSetPrototype(long layoutSetPrototypeId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Deletes the layout set prototype from the database. Also notifies the appropriate model listeners.
079            *
080            * @param layoutSetPrototype the layout set prototype
081            * @throws PortalException
082            * @throws SystemException if a system exception occurred
083            */
084            public void deleteLayoutSetPrototype(
085                    com.liferay.portal.model.LayoutSetPrototype layoutSetPrototype)
086                    throws com.liferay.portal.kernel.exception.PortalException,
087                            com.liferay.portal.kernel.exception.SystemException;
088    
089            /**
090            * Performs a dynamic query on the database and returns the matching rows.
091            *
092            * @param dynamicQuery the dynamic query
093            * @return the matching rows
094            * @throws SystemException if a system exception occurred
095            */
096            @SuppressWarnings("rawtypes")
097            public java.util.List dynamicQuery(
098                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
099                    throws com.liferay.portal.kernel.exception.SystemException;
100    
101            /**
102            * Performs a dynamic query on the database and returns a range of the matching rows.
103            *
104            * <p>
105            * 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.
106            * </p>
107            *
108            * @param dynamicQuery the dynamic query
109            * @param start the lower bound of the range of model instances
110            * @param end the upper bound of the range of model instances (not inclusive)
111            * @return the range of matching rows
112            * @throws SystemException if a system exception occurred
113            */
114            @SuppressWarnings("rawtypes")
115            public java.util.List dynamicQuery(
116                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
117                    int end) throws com.liferay.portal.kernel.exception.SystemException;
118    
119            /**
120            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
121            *
122            * <p>
123            * 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.
124            * </p>
125            *
126            * @param dynamicQuery the dynamic query
127            * @param start the lower bound of the range of model instances
128            * @param end the upper bound of the range of model instances (not inclusive)
129            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
130            * @return the ordered range of matching rows
131            * @throws SystemException if a system exception occurred
132            */
133            @SuppressWarnings("rawtypes")
134            public java.util.List dynamicQuery(
135                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
136                    int end,
137                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
138                    throws com.liferay.portal.kernel.exception.SystemException;
139    
140            /**
141            * Returns the number of rows that match the dynamic query.
142            *
143            * @param dynamicQuery the dynamic query
144            * @return the number of rows that match the dynamic query
145            * @throws SystemException if a system exception occurred
146            */
147            public long dynamicQueryCount(
148                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
149                    throws com.liferay.portal.kernel.exception.SystemException;
150    
151            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
152            public com.liferay.portal.model.LayoutSetPrototype fetchLayoutSetPrototype(
153                    long layoutSetPrototypeId)
154                    throws com.liferay.portal.kernel.exception.SystemException;
155    
156            /**
157            * Returns the layout set prototype with the primary key.
158            *
159            * @param layoutSetPrototypeId the primary key of the layout set prototype
160            * @return the layout set prototype
161            * @throws PortalException if a layout set prototype with the primary key could not be found
162            * @throws SystemException if a system exception occurred
163            */
164            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
165            public com.liferay.portal.model.LayoutSetPrototype getLayoutSetPrototype(
166                    long layoutSetPrototypeId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException;
169    
170            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
171            public com.liferay.portal.model.PersistedModel getPersistedModel(
172                    java.io.Serializable primaryKeyObj)
173                    throws com.liferay.portal.kernel.exception.PortalException,
174                            com.liferay.portal.kernel.exception.SystemException;
175    
176            /**
177            * Returns a range of all the layout set prototypes.
178            *
179            * <p>
180            * 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.
181            * </p>
182            *
183            * @param start the lower bound of the range of layout set prototypes
184            * @param end the upper bound of the range of layout set prototypes (not inclusive)
185            * @return the range of layout set prototypes
186            * @throws SystemException if a system exception occurred
187            */
188            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
189            public java.util.List<com.liferay.portal.model.LayoutSetPrototype> getLayoutSetPrototypes(
190                    int start, int end)
191                    throws com.liferay.portal.kernel.exception.SystemException;
192    
193            /**
194            * Returns the number of layout set prototypes.
195            *
196            * @return the number of layout set prototypes
197            * @throws SystemException if a system exception occurred
198            */
199            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
200            public int getLayoutSetPrototypesCount()
201                    throws com.liferay.portal.kernel.exception.SystemException;
202    
203            /**
204            * Updates the layout set prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
205            *
206            * @param layoutSetPrototype the layout set prototype
207            * @return the layout set prototype that was updated
208            * @throws SystemException if a system exception occurred
209            */
210            public com.liferay.portal.model.LayoutSetPrototype updateLayoutSetPrototype(
211                    com.liferay.portal.model.LayoutSetPrototype layoutSetPrototype)
212                    throws com.liferay.portal.kernel.exception.SystemException;
213    
214            /**
215            * Updates the layout set prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
216            *
217            * @param layoutSetPrototype the layout set prototype
218            * @param merge whether to merge the layout set prototype with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
219            * @return the layout set prototype that was updated
220            * @throws SystemException if a system exception occurred
221            */
222            public com.liferay.portal.model.LayoutSetPrototype updateLayoutSetPrototype(
223                    com.liferay.portal.model.LayoutSetPrototype layoutSetPrototype,
224                    boolean merge)
225                    throws com.liferay.portal.kernel.exception.SystemException;
226    
227            /**
228            * Returns the Spring bean ID for this bean.
229            *
230            * @return the Spring bean ID for this bean
231            */
232            public java.lang.String getBeanIdentifier();
233    
234            /**
235            * Sets the Spring bean ID for this bean.
236            *
237            * @param beanIdentifier the Spring bean ID for this bean
238            */
239            public void setBeanIdentifier(java.lang.String beanIdentifier);
240    
241            public com.liferay.portal.model.LayoutSetPrototype addLayoutSetPrototype(
242                    long userId, long companyId,
243                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
244                    java.lang.String description, boolean active,
245                    boolean layoutsUpdateable,
246                    com.liferay.portal.service.ServiceContext serviceContext)
247                    throws com.liferay.portal.kernel.exception.PortalException,
248                            com.liferay.portal.kernel.exception.SystemException;
249    
250            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
251            public com.liferay.portal.model.LayoutSetPrototype getLayoutSetPrototypeByUuid(
252                    java.lang.String uuid)
253                    throws com.liferay.portal.kernel.exception.PortalException,
254                            com.liferay.portal.kernel.exception.SystemException;
255    
256            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
257            public java.util.List<com.liferay.portal.model.LayoutSetPrototype> search(
258                    long companyId, java.lang.Boolean active, int start, int end,
259                    com.liferay.portal.kernel.util.OrderByComparator obc)
260                    throws com.liferay.portal.kernel.exception.SystemException;
261    
262            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
263            public int searchCount(long companyId, java.lang.Boolean active)
264                    throws com.liferay.portal.kernel.exception.SystemException;
265    
266            public com.liferay.portal.model.LayoutSetPrototype updateLayoutSetPrototype(
267                    long layoutSetPrototypeId,
268                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
269                    java.lang.String description, boolean active,
270                    boolean layoutsUpdateable,
271                    com.liferay.portal.service.ServiceContext serviceContext)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException;
274    
275            public com.liferay.portal.model.LayoutSetPrototype updateLayoutSetPrototype(
276                    long layoutSetPrototypeId, java.lang.String settings)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException;
279    }