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 RecentLayoutSetBranch. 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 RecentLayoutSetBranchLocalServiceUtil
034     * @see com.liferay.portal.service.base.RecentLayoutSetBranchLocalServiceBaseImpl
035     * @see com.liferay.portal.service.impl.RecentLayoutSetBranchLocalServiceImpl
036     * @generated
037     */
038    @ProviderType
039    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
040            PortalException.class, SystemException.class})
041    public interface RecentLayoutSetBranchLocalService extends BaseLocalService,
042            PersistedModelLocalService {
043            /*
044             * NOTE FOR DEVELOPERS:
045             *
046             * Never modify or reference this interface directly. Always use {@link RecentLayoutSetBranchLocalServiceUtil} to access the recent layout set branch local service. Add custom service methods to {@link com.liferay.portal.service.impl.RecentLayoutSetBranchLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
047             */
048    
049            /**
050            * Adds the recent layout set branch to the database. Also notifies the appropriate model listeners.
051            *
052            * @param recentLayoutSetBranch the recent layout set branch
053            * @return the recent layout set branch that was added
054            */
055            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
056            public com.liferay.portal.model.RecentLayoutSetBranch addRecentLayoutSetBranch(
057                    com.liferay.portal.model.RecentLayoutSetBranch recentLayoutSetBranch);
058    
059            public com.liferay.portal.model.RecentLayoutSetBranch addRecentLayoutSetBranch(
060                    long userId, long layoutSetBranchId, long layoutSetId)
061                    throws PortalException;
062    
063            /**
064            * Creates a new recent layout set branch with the primary key. Does not add the recent layout set branch to the database.
065            *
066            * @param recentLayoutSetBranchId the primary key for the new recent layout set branch
067            * @return the new recent layout set branch
068            */
069            public com.liferay.portal.model.RecentLayoutSetBranch createRecentLayoutSetBranch(
070                    long recentLayoutSetBranchId);
071    
072            /**
073            * @throws PortalException
074            */
075            @Override
076            public com.liferay.portal.model.PersistedModel deletePersistedModel(
077                    com.liferay.portal.model.PersistedModel persistedModel)
078                    throws PortalException;
079    
080            /**
081            * Deletes the recent layout set branch from the database. Also notifies the appropriate model listeners.
082            *
083            * @param recentLayoutSetBranch the recent layout set branch
084            * @return the recent layout set branch that was removed
085            */
086            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
087            public com.liferay.portal.model.RecentLayoutSetBranch deleteRecentLayoutSetBranch(
088                    com.liferay.portal.model.RecentLayoutSetBranch recentLayoutSetBranch);
089    
090            /**
091            * Deletes the recent layout set branch with the primary key from the database. Also notifies the appropriate model listeners.
092            *
093            * @param recentLayoutSetBranchId the primary key of the recent layout set branch
094            * @return the recent layout set branch that was removed
095            * @throws PortalException if a recent layout set 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.RecentLayoutSetBranch deleteRecentLayoutSetBranch(
099                    long recentLayoutSetBranchId) throws PortalException;
100    
101            public void deleteRecentLayoutSetBranches(long layoutSetBranchId);
102    
103            public void deleteUserRecentLayoutSetBranches(long userId);
104    
105            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
106    
107            /**
108            * Performs a dynamic query on the database and returns the matching rows.
109            *
110            * @param dynamicQuery the dynamic query
111            * @return the matching rows
112            */
113            public <T> java.util.List<T> dynamicQuery(
114                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
115    
116            /**
117            * Performs a dynamic query on the database and returns a range of the matching rows.
118            *
119            * <p>
120            * 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.RecentLayoutSetBranchModelImpl}. 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.
121            * </p>
122            *
123            * @param dynamicQuery the dynamic query
124            * @param start the lower bound of the range of model instances
125            * @param end the upper bound of the range of model instances (not inclusive)
126            * @return the range of matching rows
127            */
128            public <T> java.util.List<T> dynamicQuery(
129                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
130                    int end);
131    
132            /**
133            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
134            *
135            * <p>
136            * 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.RecentLayoutSetBranchModelImpl}. 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.
137            * </p>
138            *
139            * @param dynamicQuery the dynamic query
140            * @param start the lower bound of the range of model instances
141            * @param end the upper bound of the range of model instances (not inclusive)
142            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
143            * @return the ordered range of matching rows
144            */
145            public <T> java.util.List<T> dynamicQuery(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
147                    int end,
148                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
149    
150            /**
151            * Returns the number of rows matching the dynamic query.
152            *
153            * @param dynamicQuery the dynamic query
154            * @return the number of rows matching the dynamic query
155            */
156            public long dynamicQueryCount(
157                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
158    
159            /**
160            * Returns the number of rows matching the dynamic query.
161            *
162            * @param dynamicQuery the dynamic query
163            * @param projection the projection to apply to the query
164            * @return the number of rows matching the dynamic query
165            */
166            public long dynamicQueryCount(
167                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
168                    com.liferay.portal.kernel.dao.orm.Projection projection);
169    
170            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
171            public com.liferay.portal.model.RecentLayoutSetBranch fetchRecentLayoutSetBranch(
172                    long recentLayoutSetBranchId);
173    
174            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
175            public com.liferay.portal.model.RecentLayoutSetBranch fetchRecentLayoutSetBranch(
176                    long userId, long layoutSetId);
177    
178            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
180    
181            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
182            public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
183    
184            /**
185            * Returns the OSGi service identifier.
186            *
187            * @return the OSGi service identifier
188            */
189            public java.lang.String getOSGiServiceIdentifier();
190    
191            @Override
192            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
193            public com.liferay.portal.model.PersistedModel getPersistedModel(
194                    java.io.Serializable primaryKeyObj) throws PortalException;
195    
196            /**
197            * Returns the recent layout set branch with the primary key.
198            *
199            * @param recentLayoutSetBranchId the primary key of the recent layout set branch
200            * @return the recent layout set branch
201            * @throws PortalException if a recent layout set branch with the primary key could not be found
202            */
203            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
204            public com.liferay.portal.model.RecentLayoutSetBranch getRecentLayoutSetBranch(
205                    long recentLayoutSetBranchId) throws PortalException;
206    
207            /**
208            * Returns a range of all the recent layout set branchs.
209            *
210            * <p>
211            * 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.RecentLayoutSetBranchModelImpl}. 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.
212            * </p>
213            *
214            * @param start the lower bound of the range of recent layout set branchs
215            * @param end the upper bound of the range of recent layout set branchs (not inclusive)
216            * @return the range of recent layout set branchs
217            */
218            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
219            public java.util.List<com.liferay.portal.model.RecentLayoutSetBranch> getRecentLayoutSetBranchs(
220                    int start, int end);
221    
222            /**
223            * Returns the number of recent layout set branchs.
224            *
225            * @return the number of recent layout set branchs
226            */
227            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
228            public int getRecentLayoutSetBranchsCount();
229    
230            /**
231            * Updates the recent layout set branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
232            *
233            * @param recentLayoutSetBranch the recent layout set branch
234            * @return the recent layout set branch that was updated
235            */
236            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
237            public com.liferay.portal.model.RecentLayoutSetBranch updateRecentLayoutSetBranch(
238                    com.liferay.portal.model.RecentLayoutSetBranch recentLayoutSetBranch);
239    }