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