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 branch 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 LayoutSetBranchLocalServiceUtil
032     * @see com.liferay.portal.service.base.LayoutSetBranchLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.LayoutSetBranchLocalServiceImpl
034     * @generated
035     */
036    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
037            PortalException.class, SystemException.class})
038    public interface LayoutSetBranchLocalService extends PersistedModelLocalService {
039            /*
040             * NOTE FOR DEVELOPERS:
041             *
042             * Never modify or reference this interface directly. Always use {@link LayoutSetBranchLocalServiceUtil} to access the layout set branch local service. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutSetBranchLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
043             */
044    
045            /**
046            * Adds the layout set branch to the database. Also notifies the appropriate model listeners.
047            *
048            * @param layoutSetBranch the layout set branch
049            * @return the layout set branch that was added
050            * @throws SystemException if a system exception occurred
051            */
052            public com.liferay.portal.model.LayoutSetBranch addLayoutSetBranch(
053                    com.liferay.portal.model.LayoutSetBranch layoutSetBranch)
054                    throws com.liferay.portal.kernel.exception.SystemException;
055    
056            /**
057            * Creates a new layout set branch with the primary key. Does not add the layout set branch to the database.
058            *
059            * @param layoutSetBranchId the primary key for the new layout set branch
060            * @return the new layout set branch
061            */
062            public com.liferay.portal.model.LayoutSetBranch createLayoutSetBranch(
063                    long layoutSetBranchId);
064    
065            /**
066            * Deletes the layout set branch with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param layoutSetBranchId the primary key of the layout set branch
069            * @throws PortalException if a layout set branch with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public void deleteLayoutSetBranch(long layoutSetBranchId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException;
075    
076            /**
077            * Deletes the layout set branch from the database. Also notifies the appropriate model listeners.
078            *
079            * @param layoutSetBranch the layout set branch
080            * @throws PortalException
081            * @throws SystemException if a system exception occurred
082            */
083            public void deleteLayoutSetBranch(
084                    com.liferay.portal.model.LayoutSetBranch layoutSetBranch)
085                    throws com.liferay.portal.kernel.exception.PortalException,
086                            com.liferay.portal.kernel.exception.SystemException;
087    
088            /**
089            * Performs a dynamic query on the database and returns the matching rows.
090            *
091            * @param dynamicQuery the dynamic query
092            * @return the matching rows
093            * @throws SystemException if a system exception occurred
094            */
095            @SuppressWarnings("rawtypes")
096            public java.util.List dynamicQuery(
097                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
098                    throws com.liferay.portal.kernel.exception.SystemException;
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * 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.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query
108            * @param start the lower bound of the range of model instances
109            * @param end the upper bound of the range of model instances (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException;
117    
118            /**
119            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
120            *
121            * <p>
122            * 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.
123            * </p>
124            *
125            * @param dynamicQuery the dynamic query
126            * @param start the lower bound of the range of model instances
127            * @param end the upper bound of the range of model instances (not inclusive)
128            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
129            * @return the ordered range of matching rows
130            * @throws SystemException if a system exception occurred
131            */
132            @SuppressWarnings("rawtypes")
133            public java.util.List dynamicQuery(
134                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
135                    int end,
136                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
137                    throws com.liferay.portal.kernel.exception.SystemException;
138    
139            /**
140            * Returns the number of rows that match the dynamic query.
141            *
142            * @param dynamicQuery the dynamic query
143            * @return the number of rows that match the dynamic query
144            * @throws SystemException if a system exception occurred
145            */
146            public long dynamicQueryCount(
147                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
148                    throws com.liferay.portal.kernel.exception.SystemException;
149    
150            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
151            public com.liferay.portal.model.LayoutSetBranch fetchLayoutSetBranch(
152                    long layoutSetBranchId)
153                    throws com.liferay.portal.kernel.exception.SystemException;
154    
155            /**
156            * Returns the layout set branch with the primary key.
157            *
158            * @param layoutSetBranchId the primary key of the layout set branch
159            * @return the layout set branch
160            * @throws PortalException if a layout set branch with the primary key could not be found
161            * @throws SystemException if a system exception occurred
162            */
163            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164            public com.liferay.portal.model.LayoutSetBranch getLayoutSetBranch(
165                    long layoutSetBranchId)
166                    throws com.liferay.portal.kernel.exception.PortalException,
167                            com.liferay.portal.kernel.exception.SystemException;
168    
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public com.liferay.portal.model.PersistedModel getPersistedModel(
171                    java.io.Serializable primaryKeyObj)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            /**
176            * Returns a range of all the layout set branchs.
177            *
178            * <p>
179            * 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.
180            * </p>
181            *
182            * @param start the lower bound of the range of layout set branchs
183            * @param end the upper bound of the range of layout set branchs (not inclusive)
184            * @return the range of layout set branchs
185            * @throws SystemException if a system exception occurred
186            */
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public java.util.List<com.liferay.portal.model.LayoutSetBranch> getLayoutSetBranchs(
189                    int start, int end)
190                    throws com.liferay.portal.kernel.exception.SystemException;
191    
192            /**
193            * Returns the number of layout set branchs.
194            *
195            * @return the number of layout set branchs
196            * @throws SystemException if a system exception occurred
197            */
198            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199            public int getLayoutSetBranchsCount()
200                    throws com.liferay.portal.kernel.exception.SystemException;
201    
202            /**
203            * Updates the layout set branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
204            *
205            * @param layoutSetBranch the layout set branch
206            * @return the layout set branch that was updated
207            * @throws SystemException if a system exception occurred
208            */
209            public com.liferay.portal.model.LayoutSetBranch updateLayoutSetBranch(
210                    com.liferay.portal.model.LayoutSetBranch layoutSetBranch)
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Updates the layout set branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
215            *
216            * @param layoutSetBranch the layout set branch
217            * @param merge whether to merge the layout set branch 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.
218            * @return the layout set branch that was updated
219            * @throws SystemException if a system exception occurred
220            */
221            public com.liferay.portal.model.LayoutSetBranch updateLayoutSetBranch(
222                    com.liferay.portal.model.LayoutSetBranch layoutSetBranch, boolean merge)
223                    throws com.liferay.portal.kernel.exception.SystemException;
224    
225            /**
226            * Returns the Spring bean ID for this bean.
227            *
228            * @return the Spring bean ID for this bean
229            */
230            public java.lang.String getBeanIdentifier();
231    
232            /**
233            * Sets the Spring bean ID for this bean.
234            *
235            * @param beanIdentifier the Spring bean ID for this bean
236            */
237            public void setBeanIdentifier(java.lang.String beanIdentifier);
238    
239            public com.liferay.portal.model.LayoutSetBranch addLayoutSetBranch(
240                    long userId, long groupId, boolean privateLayout,
241                    java.lang.String name, java.lang.String description, boolean master,
242                    long copyLayoutSetBranchId,
243                    com.liferay.portal.service.ServiceContext serviceContext)
244                    throws com.liferay.portal.kernel.exception.PortalException,
245                            com.liferay.portal.kernel.exception.SystemException;
246    
247            public void deleteLayoutSetBranch(
248                    com.liferay.portal.model.LayoutSetBranch layoutSetBranch,
249                    boolean includeMaster)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException;
252    
253            public void deleteLayoutSetBranches(long groupId, boolean privateLayout)
254                    throws com.liferay.portal.kernel.exception.PortalException,
255                            com.liferay.portal.kernel.exception.SystemException;
256    
257            public void deleteLayoutSetBranches(long groupId, boolean privateLayout,
258                    boolean includeMaster)
259                    throws com.liferay.portal.kernel.exception.PortalException,
260                            com.liferay.portal.kernel.exception.SystemException;
261    
262            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
263            public com.liferay.portal.model.LayoutSetBranch getLayoutSetBranch(
264                    long groupId, boolean privateLayout, java.lang.String name)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException;
267    
268            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
269            public java.util.List<com.liferay.portal.model.LayoutSetBranch> getLayoutSetBranches(
270                    long groupId, boolean privateLayout)
271                    throws com.liferay.portal.kernel.exception.SystemException;
272    
273            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
274            public com.liferay.portal.model.LayoutSetBranch getMasterLayoutSetBranch(
275                    long groupId, boolean privateLayout)
276                    throws com.liferay.portal.kernel.exception.PortalException,
277                            com.liferay.portal.kernel.exception.SystemException;
278    
279            /**
280            * @deprecated {@link #getUserLayoutSetBranch(long, long, boolean, long, long)}
281            */
282            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
283            public com.liferay.portal.model.LayoutSetBranch getUserLayoutSetBranch(
284                    long userId, long groupId, boolean privateLayout, long layoutSetBranchId)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException;
287    
288            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
289            public com.liferay.portal.model.LayoutSetBranch getUserLayoutSetBranch(
290                    long userId, long groupId, boolean privateLayout, long layoutSetId,
291                    long layoutSetBranchId)
292                    throws com.liferay.portal.kernel.exception.PortalException,
293                            com.liferay.portal.kernel.exception.SystemException;
294    
295            public com.liferay.portal.model.LayoutSetBranch mergeLayoutSetBranch(
296                    long layoutSetBranchId, long mergeLayoutSetBranchId,
297                    com.liferay.portal.service.ServiceContext serviceContext)
298                    throws com.liferay.portal.kernel.exception.PortalException,
299                            com.liferay.portal.kernel.exception.SystemException;
300    
301            public com.liferay.portal.model.LayoutSetBranch updateLayoutSetBranch(
302                    long layoutSetBranchId, java.lang.String name,
303                    java.lang.String description,
304                    com.liferay.portal.service.ServiceContext serviceContext)
305                    throws com.liferay.portal.kernel.exception.PortalException,
306                            com.liferay.portal.kernel.exception.SystemException;
307    }