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