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.dao.orm.ActionableDynamicQuery;
020    import com.liferay.portal.kernel.dao.orm.DynamicQuery;
021    import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
022    import com.liferay.portal.kernel.dao.orm.Projection;
023    import com.liferay.portal.kernel.exception.PortalException;
024    import com.liferay.portal.kernel.exception.SystemException;
025    import com.liferay.portal.kernel.search.Indexable;
026    import com.liferay.portal.kernel.search.IndexableType;
027    import com.liferay.portal.kernel.transaction.Isolation;
028    import com.liferay.portal.kernel.transaction.Propagation;
029    import com.liferay.portal.kernel.transaction.Transactional;
030    import com.liferay.portal.kernel.util.OrderByComparator;
031    import com.liferay.portal.model.LayoutSetBranch;
032    import com.liferay.portal.model.PersistedModel;
033    
034    import java.io.Serializable;
035    
036    import java.util.List;
037    
038    /**
039     * Provides the local service interface for LayoutSetBranch. Methods of this
040     * service will not have security checks based on the propagated JAAS
041     * credentials because this service can only be accessed from within the same
042     * VM.
043     *
044     * @author Brian Wing Shun Chan
045     * @see LayoutSetBranchLocalServiceUtil
046     * @see com.liferay.portal.service.base.LayoutSetBranchLocalServiceBaseImpl
047     * @see com.liferay.portal.service.impl.LayoutSetBranchLocalServiceImpl
048     * @generated
049     */
050    @ProviderType
051    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
052            PortalException.class, SystemException.class})
053    public interface LayoutSetBranchLocalService extends BaseLocalService,
054            PersistedModelLocalService {
055            /*
056             * NOTE FOR DEVELOPERS:
057             *
058             * 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.
059             */
060    
061            /**
062            * Adds the layout set branch to the database. Also notifies the appropriate model listeners.
063            *
064            * @param layoutSetBranch the layout set branch
065            * @return the layout set branch that was added
066            */
067            @Indexable(type = IndexableType.REINDEX)
068            public LayoutSetBranch addLayoutSetBranch(LayoutSetBranch layoutSetBranch);
069    
070            public LayoutSetBranch addLayoutSetBranch(long userId, long groupId,
071                    boolean privateLayout, java.lang.String name,
072                    java.lang.String description, boolean master,
073                    long copyLayoutSetBranchId,
074                    com.liferay.portal.service.ServiceContext serviceContext)
075                    throws PortalException;
076    
077            /**
078            * Creates a new layout set branch with the primary key. Does not add the layout set branch to the database.
079            *
080            * @param layoutSetBranchId the primary key for the new layout set branch
081            * @return the new layout set branch
082            */
083            public LayoutSetBranch createLayoutSetBranch(long layoutSetBranchId);
084    
085            /**
086            * Deletes the layout set branch from the database. Also notifies the appropriate model listeners.
087            *
088            * @param layoutSetBranch the layout set branch
089            * @return the layout set branch that was removed
090            * @throws PortalException
091            */
092            @Indexable(type = IndexableType.DELETE)
093            public LayoutSetBranch deleteLayoutSetBranch(
094                    LayoutSetBranch layoutSetBranch) throws PortalException;
095    
096            public LayoutSetBranch deleteLayoutSetBranch(
097                    LayoutSetBranch layoutSetBranch, boolean includeMaster)
098                    throws PortalException;
099    
100            /**
101            * Deletes the layout set branch with the primary key from the database. Also notifies the appropriate model listeners.
102            *
103            * @param layoutSetBranchId the primary key of the layout set branch
104            * @return the layout set branch that was removed
105            * @throws PortalException if a layout set branch with the primary key could not be found
106            */
107            @Indexable(type = IndexableType.DELETE)
108            public LayoutSetBranch deleteLayoutSetBranch(long layoutSetBranchId)
109                    throws PortalException;
110    
111            public void deleteLayoutSetBranches(long groupId, boolean privateLayout)
112                    throws PortalException;
113    
114            public void deleteLayoutSetBranches(long groupId, boolean privateLayout,
115                    boolean includeMaster) throws PortalException;
116    
117            /**
118            * @throws PortalException
119            */
120            @Override
121            public PersistedModel deletePersistedModel(PersistedModel persistedModel)
122                    throws PortalException;
123    
124            public DynamicQuery dynamicQuery();
125    
126            /**
127            * Performs a dynamic query on the database and returns the matching rows.
128            *
129            * @param dynamicQuery the dynamic query
130            * @return the matching rows
131            */
132            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery);
133    
134            /**
135            * Performs a dynamic query on the database and returns a range of the matching rows.
136            *
137            * <p>
138            * 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.LayoutSetBranchModelImpl}. 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.
139            * </p>
140            *
141            * @param dynamicQuery the dynamic query
142            * @param start the lower bound of the range of model instances
143            * @param end the upper bound of the range of model instances (not inclusive)
144            * @return the range of matching rows
145            */
146            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
147                    int end);
148    
149            /**
150            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
151            *
152            * <p>
153            * 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.LayoutSetBranchModelImpl}. 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.
154            * </p>
155            *
156            * @param dynamicQuery the dynamic query
157            * @param start the lower bound of the range of model instances
158            * @param end the upper bound of the range of model instances (not inclusive)
159            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
160            * @return the ordered range of matching rows
161            */
162            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
163                    int end, OrderByComparator<T> orderByComparator);
164    
165            /**
166            * Returns the number of rows matching the dynamic query.
167            *
168            * @param dynamicQuery the dynamic query
169            * @return the number of rows matching the dynamic query
170            */
171            public long dynamicQueryCount(DynamicQuery dynamicQuery);
172    
173            /**
174            * Returns the number of rows matching the dynamic query.
175            *
176            * @param dynamicQuery the dynamic query
177            * @param projection the projection to apply to the query
178            * @return the number of rows matching the dynamic query
179            */
180            public long dynamicQueryCount(DynamicQuery dynamicQuery,
181                    Projection projection);
182    
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public LayoutSetBranch fetchLayoutSetBranch(long groupId,
185                    boolean privateLayout, java.lang.String name);
186    
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public LayoutSetBranch fetchLayoutSetBranch(long layoutSetBranchId);
189    
190            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
191            public ActionableDynamicQuery getActionableDynamicQuery();
192    
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
195    
196            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
197            public LayoutSetBranch getLayoutSetBranch(long groupId,
198                    boolean privateLayout, java.lang.String name) throws PortalException;
199    
200            /**
201            * Returns the layout set branch with the primary key.
202            *
203            * @param layoutSetBranchId the primary key of the layout set branch
204            * @return the layout set branch
205            * @throws PortalException if a layout set branch with the primary key could not be found
206            */
207            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208            public LayoutSetBranch getLayoutSetBranch(long layoutSetBranchId)
209                    throws PortalException;
210    
211            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
212            public List<LayoutSetBranch> getLayoutSetBranches(long groupId,
213                    boolean privateLayout);
214    
215            /**
216            * Returns a range of all the layout set branchs.
217            *
218            * <p>
219            * 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.LayoutSetBranchModelImpl}. 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.
220            * </p>
221            *
222            * @param start the lower bound of the range of layout set branchs
223            * @param end the upper bound of the range of layout set branchs (not inclusive)
224            * @return the range of layout set branchs
225            */
226            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
227            public List<LayoutSetBranch> getLayoutSetBranchs(int start, int end);
228    
229            /**
230            * Returns the number of layout set branchs.
231            *
232            * @return the number of layout set branchs
233            */
234            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
235            public int getLayoutSetBranchsCount();
236    
237            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
238            public LayoutSetBranch getMasterLayoutSetBranch(long groupId,
239                    boolean privateLayout) throws PortalException;
240    
241            /**
242            * Returns the OSGi service identifier.
243            *
244            * @return the OSGi service identifier
245            */
246            public java.lang.String getOSGiServiceIdentifier();
247    
248            @Override
249            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
250            public PersistedModel getPersistedModel(Serializable primaryKeyObj)
251                    throws PortalException;
252    
253            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
254            public LayoutSetBranch getUserLayoutSetBranch(long userId, long groupId,
255                    boolean privateLayout, long layoutSetId, long layoutSetBranchId)
256                    throws PortalException;
257    
258            public LayoutSetBranch mergeLayoutSetBranch(long layoutSetBranchId,
259                    long mergeLayoutSetBranchId,
260                    com.liferay.portal.service.ServiceContext serviceContext)
261                    throws PortalException;
262    
263            /**
264            * Updates the layout set branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
265            *
266            * @param layoutSetBranch the layout set branch
267            * @return the layout set branch that was updated
268            */
269            @Indexable(type = IndexableType.REINDEX)
270            public LayoutSetBranch updateLayoutSetBranch(
271                    LayoutSetBranch layoutSetBranch);
272    
273            public LayoutSetBranch updateLayoutSetBranch(long layoutSetBranchId,
274                    java.lang.String name, java.lang.String description,
275                    com.liferay.portal.service.ServiceContext serviceContext)
276                    throws PortalException;
277    }