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.portlet.journal.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    import com.liferay.portal.service.BaseLocalService;
026    import com.liferay.portal.service.PersistedModelLocalService;
027    
028    /**
029     * Provides the local service interface for JournalContentSearch. Methods of this
030     * service will not have security checks based on the propagated JAAS
031     * credentials because this service can only be accessed from within the same
032     * VM.
033     *
034     * @author Brian Wing Shun Chan
035     * @see JournalContentSearchLocalServiceUtil
036     * @see com.liferay.portlet.journal.service.base.JournalContentSearchLocalServiceBaseImpl
037     * @see com.liferay.portlet.journal.service.impl.JournalContentSearchLocalServiceImpl
038     * @generated
039     */
040    @ProviderType
041    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface JournalContentSearchLocalService extends BaseLocalService,
044            PersistedModelLocalService {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. Always use {@link JournalContentSearchLocalServiceUtil} to access the journal content search local service. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalContentSearchLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
049             */
050    
051            /**
052            * Adds the journal content search to the database. Also notifies the appropriate model listeners.
053            *
054            * @param journalContentSearch the journal content search
055            * @return the journal content search that was added
056            */
057            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
058            public com.liferay.portlet.journal.model.JournalContentSearch addJournalContentSearch(
059                    com.liferay.portlet.journal.model.JournalContentSearch journalContentSearch);
060    
061            public void checkContentSearches(long companyId)
062                    throws com.liferay.portal.kernel.exception.PortalException;
063    
064            /**
065            * Creates a new journal content search with the primary key. Does not add the journal content search to the database.
066            *
067            * @param contentSearchId the primary key for the new journal content search
068            * @return the new journal content search
069            */
070            public com.liferay.portlet.journal.model.JournalContentSearch createJournalContentSearch(
071                    long contentSearchId);
072    
073            public void deleteArticleContentSearch(long groupId, boolean privateLayout,
074                    long layoutId, java.lang.String portletId);
075    
076            public void deleteArticleContentSearch(long groupId, boolean privateLayout,
077                    long layoutId, java.lang.String portletId, java.lang.String articleId);
078    
079            public void deleteArticleContentSearches(long groupId,
080                    java.lang.String articleId);
081    
082            /**
083            * Deletes the journal content search with the primary key from the database. Also notifies the appropriate model listeners.
084            *
085            * @param contentSearchId the primary key of the journal content search
086            * @return the journal content search that was removed
087            * @throws PortalException if a journal content search with the primary key could not be found
088            */
089            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
090            public com.liferay.portlet.journal.model.JournalContentSearch deleteJournalContentSearch(
091                    long contentSearchId)
092                    throws com.liferay.portal.kernel.exception.PortalException;
093    
094            /**
095            * Deletes the journal content search from the database. Also notifies the appropriate model listeners.
096            *
097            * @param journalContentSearch the journal content search
098            * @return the journal content search that was removed
099            */
100            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
101            public com.liferay.portlet.journal.model.JournalContentSearch deleteJournalContentSearch(
102                    com.liferay.portlet.journal.model.JournalContentSearch journalContentSearch);
103    
104            public void deleteLayoutContentSearches(long groupId,
105                    boolean privateLayout, long layoutId);
106    
107            public void deleteOwnerContentSearches(long groupId, boolean privateLayout);
108    
109            /**
110            * @throws PortalException
111            */
112            @Override
113            public com.liferay.portal.model.PersistedModel deletePersistedModel(
114                    com.liferay.portal.model.PersistedModel persistedModel)
115                    throws com.liferay.portal.kernel.exception.PortalException;
116    
117            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
118    
119            /**
120            * Performs a dynamic query on the database and returns the matching rows.
121            *
122            * @param dynamicQuery the dynamic query
123            * @return the matching rows
124            */
125            public <T> java.util.List<T> dynamicQuery(
126                    com.liferay.portal.kernel.dao.orm.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.portlet.journal.model.impl.JournalContentSearchModelImpl}. 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> java.util.List<T> dynamicQuery(
141                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
142                    int end);
143    
144            /**
145            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
146            *
147            * <p>
148            * 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.portlet.journal.model.impl.JournalContentSearchModelImpl}. 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.
149            * </p>
150            *
151            * @param dynamicQuery the dynamic query
152            * @param start the lower bound of the range of model instances
153            * @param end the upper bound of the range of model instances (not inclusive)
154            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
155            * @return the ordered range of matching rows
156            */
157            public <T> java.util.List<T> dynamicQuery(
158                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
159                    int end,
160                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
161    
162            /**
163            * Returns the number of rows matching the dynamic query.
164            *
165            * @param dynamicQuery the dynamic query
166            * @return the number of rows matching the dynamic query
167            */
168            public long dynamicQueryCount(
169                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
170    
171            /**
172            * Returns the number of rows matching the dynamic query.
173            *
174            * @param dynamicQuery the dynamic query
175            * @param projection the projection to apply to the query
176            * @return the number of rows matching the dynamic query
177            */
178            public long dynamicQueryCount(
179                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
180                    com.liferay.portal.kernel.dao.orm.Projection projection);
181    
182            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
183            public com.liferay.portlet.journal.model.JournalContentSearch fetchJournalContentSearch(
184                    long contentSearchId);
185    
186            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
187            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
188    
189            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
190            public java.util.List<com.liferay.portlet.journal.model.JournalContentSearch> getArticleContentSearches();
191    
192            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
193            public java.util.List<com.liferay.portlet.journal.model.JournalContentSearch> getArticleContentSearches(
194                    java.lang.String articleId);
195    
196            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
197            public java.util.List<com.liferay.portlet.journal.model.JournalContentSearch> getArticleContentSearches(
198                    long groupId, java.lang.String articleId);
199    
200            /**
201            * Returns the Spring bean ID for this bean.
202            *
203            * @return the Spring bean ID for this bean
204            */
205            public java.lang.String getBeanIdentifier();
206    
207            /**
208            * Returns the journal content search with the primary key.
209            *
210            * @param contentSearchId the primary key of the journal content search
211            * @return the journal content search
212            * @throws PortalException if a journal content search with the primary key could not be found
213            */
214            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
215            public com.liferay.portlet.journal.model.JournalContentSearch getJournalContentSearch(
216                    long contentSearchId)
217                    throws com.liferay.portal.kernel.exception.PortalException;
218    
219            /**
220            * Returns a range of all the journal content searchs.
221            *
222            * <p>
223            * 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.portlet.journal.model.impl.JournalContentSearchModelImpl}. 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.
224            * </p>
225            *
226            * @param start the lower bound of the range of journal content searchs
227            * @param end the upper bound of the range of journal content searchs (not inclusive)
228            * @return the range of journal content searchs
229            */
230            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
231            public java.util.List<com.liferay.portlet.journal.model.JournalContentSearch> getJournalContentSearchs(
232                    int start, int end);
233    
234            /**
235            * Returns the number of journal content searchs.
236            *
237            * @return the number of journal content searchs
238            */
239            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
240            public int getJournalContentSearchsCount();
241    
242            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
243            public java.util.List<java.lang.Long> getLayoutIds(long groupId,
244                    boolean privateLayout, java.lang.String articleId);
245    
246            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
247            public int getLayoutIdsCount(java.lang.String articleId);
248    
249            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
250            public int getLayoutIdsCount(long groupId, boolean privateLayout,
251                    java.lang.String articleId);
252    
253            @Override
254            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
255            public com.liferay.portal.model.PersistedModel getPersistedModel(
256                    java.io.Serializable primaryKeyObj)
257                    throws com.liferay.portal.kernel.exception.PortalException;
258    
259            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
260            public java.util.List<com.liferay.portlet.journal.model.JournalContentSearch> getPortletContentSearches(
261                    java.lang.String portletId);
262    
263            /**
264            * Sets the Spring bean ID for this bean.
265            *
266            * @param beanIdentifier the Spring bean ID for this bean
267            */
268            public void setBeanIdentifier(java.lang.String beanIdentifier);
269    
270            public com.liferay.portlet.journal.model.JournalContentSearch updateContentSearch(
271                    long groupId, boolean privateLayout, long layoutId,
272                    java.lang.String portletId, java.lang.String articleId)
273                    throws com.liferay.portal.kernel.exception.PortalException;
274    
275            public com.liferay.portlet.journal.model.JournalContentSearch updateContentSearch(
276                    long groupId, boolean privateLayout, long layoutId,
277                    java.lang.String portletId, java.lang.String articleId, boolean purge)
278                    throws com.liferay.portal.kernel.exception.PortalException;
279    
280            public java.util.List<com.liferay.portlet.journal.model.JournalContentSearch> updateContentSearch(
281                    long groupId, boolean privateLayout, long layoutId,
282                    java.lang.String portletId, java.lang.String[] articleIds)
283                    throws com.liferay.portal.kernel.exception.PortalException;
284    
285            /**
286            * Updates the journal content search in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
287            *
288            * @param journalContentSearch the journal content search
289            * @return the journal content search that was updated
290            */
291            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
292            public com.liferay.portlet.journal.model.JournalContentSearch updateJournalContentSearch(
293                    com.liferay.portlet.journal.model.JournalContentSearch journalContentSearch);
294    }