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) throws PortalException; 062 063 /** 064 * Creates a new journal content search with the primary key. Does not add the journal content search to the database. 065 * 066 * @param contentSearchId the primary key for the new journal content search 067 * @return the new journal content search 068 */ 069 public com.liferay.portlet.journal.model.JournalContentSearch createJournalContentSearch( 070 long contentSearchId); 071 072 public void deleteArticleContentSearch(long groupId, boolean privateLayout, 073 long layoutId, java.lang.String portletId); 074 075 public void deleteArticleContentSearch(long groupId, boolean privateLayout, 076 long layoutId, java.lang.String portletId, java.lang.String articleId); 077 078 public void deleteArticleContentSearches(long groupId, 079 java.lang.String articleId); 080 081 /** 082 * Deletes the journal content search with the primary key from the database. Also notifies the appropriate model listeners. 083 * 084 * @param contentSearchId the primary key of the journal content search 085 * @return the journal content search that was removed 086 * @throws PortalException if a journal content search with the primary key could not be found 087 */ 088 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 089 public com.liferay.portlet.journal.model.JournalContentSearch deleteJournalContentSearch( 090 long contentSearchId) throws PortalException; 091 092 /** 093 * Deletes the journal content search from the database. Also notifies the appropriate model listeners. 094 * 095 * @param journalContentSearch the journal content search 096 * @return the journal content search that was removed 097 */ 098 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 099 public com.liferay.portlet.journal.model.JournalContentSearch deleteJournalContentSearch( 100 com.liferay.portlet.journal.model.JournalContentSearch journalContentSearch); 101 102 public void deleteLayoutContentSearches(long groupId, 103 boolean privateLayout, long layoutId); 104 105 public void deleteOwnerContentSearches(long groupId, boolean privateLayout); 106 107 /** 108 * @throws PortalException 109 */ 110 @Override 111 public com.liferay.portal.model.PersistedModel deletePersistedModel( 112 com.liferay.portal.model.PersistedModel persistedModel) 113 throws PortalException; 114 115 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 116 117 /** 118 * Performs a dynamic query on the database and returns the matching rows. 119 * 120 * @param dynamicQuery the dynamic query 121 * @return the matching rows 122 */ 123 public <T> java.util.List<T> dynamicQuery( 124 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 125 126 /** 127 * Performs a dynamic query on the database and returns a range of the matching rows. 128 * 129 * <p> 130 * 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. 131 * </p> 132 * 133 * @param dynamicQuery the dynamic query 134 * @param start the lower bound of the range of model instances 135 * @param end the upper bound of the range of model instances (not inclusive) 136 * @return the range of matching rows 137 */ 138 public <T> java.util.List<T> dynamicQuery( 139 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 140 int end); 141 142 /** 143 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 144 * 145 * <p> 146 * 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. 147 * </p> 148 * 149 * @param dynamicQuery the dynamic query 150 * @param start the lower bound of the range of model instances 151 * @param end the upper bound of the range of model instances (not inclusive) 152 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 153 * @return the ordered range of matching rows 154 */ 155 public <T> java.util.List<T> dynamicQuery( 156 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 157 int end, 158 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 159 160 /** 161 * Returns the number of rows matching the dynamic query. 162 * 163 * @param dynamicQuery the dynamic 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 169 /** 170 * Returns the number of rows matching the dynamic query. 171 * 172 * @param dynamicQuery the dynamic query 173 * @param projection the projection to apply to the query 174 * @return the number of rows matching the dynamic query 175 */ 176 public long dynamicQueryCount( 177 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 178 com.liferay.portal.kernel.dao.orm.Projection projection); 179 180 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 181 public com.liferay.portlet.journal.model.JournalContentSearch fetchJournalContentSearch( 182 long contentSearchId); 183 184 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 185 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 186 187 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 188 public java.util.List<com.liferay.portlet.journal.model.JournalContentSearch> getArticleContentSearches(); 189 190 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 191 public java.util.List<com.liferay.portlet.journal.model.JournalContentSearch> getArticleContentSearches( 192 java.lang.String articleId); 193 194 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 195 public java.util.List<com.liferay.portlet.journal.model.JournalContentSearch> getArticleContentSearches( 196 long groupId, java.lang.String articleId); 197 198 /** 199 * Returns the Spring bean ID for this bean. 200 * 201 * @return the Spring bean ID for this bean 202 */ 203 public java.lang.String getBeanIdentifier(); 204 205 /** 206 * Returns the journal content search with the primary key. 207 * 208 * @param contentSearchId the primary key of the journal content search 209 * @return the journal content search 210 * @throws PortalException if a journal content search with the primary key could not be found 211 */ 212 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 213 public com.liferay.portlet.journal.model.JournalContentSearch getJournalContentSearch( 214 long contentSearchId) throws PortalException; 215 216 /** 217 * Returns a range of all the journal content searchs. 218 * 219 * <p> 220 * 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. 221 * </p> 222 * 223 * @param start the lower bound of the range of journal content searchs 224 * @param end the upper bound of the range of journal content searchs (not inclusive) 225 * @return the range of journal content searchs 226 */ 227 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 228 public java.util.List<com.liferay.portlet.journal.model.JournalContentSearch> getJournalContentSearchs( 229 int start, int end); 230 231 /** 232 * Returns the number of journal content searchs. 233 * 234 * @return the number of journal content searchs 235 */ 236 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 237 public int getJournalContentSearchsCount(); 238 239 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 240 public java.util.List<java.lang.Long> getLayoutIds(long groupId, 241 boolean privateLayout, java.lang.String articleId); 242 243 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 244 public int getLayoutIdsCount(java.lang.String articleId); 245 246 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 247 public int getLayoutIdsCount(long groupId, boolean privateLayout, 248 java.lang.String articleId); 249 250 @Override 251 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 252 public com.liferay.portal.model.PersistedModel getPersistedModel( 253 java.io.Serializable primaryKeyObj) throws PortalException; 254 255 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 256 public java.util.List<com.liferay.portlet.journal.model.JournalContentSearch> getPortletContentSearches( 257 java.lang.String portletId); 258 259 /** 260 * Sets the Spring bean ID for this bean. 261 * 262 * @param beanIdentifier the Spring bean ID for this bean 263 */ 264 public void setBeanIdentifier(java.lang.String beanIdentifier); 265 266 public com.liferay.portlet.journal.model.JournalContentSearch updateContentSearch( 267 long groupId, boolean privateLayout, long layoutId, 268 java.lang.String portletId, java.lang.String articleId) 269 throws PortalException; 270 271 public com.liferay.portlet.journal.model.JournalContentSearch updateContentSearch( 272 long groupId, boolean privateLayout, long layoutId, 273 java.lang.String portletId, java.lang.String articleId, boolean purge) 274 throws PortalException; 275 276 public java.util.List<com.liferay.portlet.journal.model.JournalContentSearch> updateContentSearch( 277 long groupId, boolean privateLayout, long layoutId, 278 java.lang.String portletId, java.lang.String[] articleIds) 279 throws PortalException; 280 281 /** 282 * Updates the journal content search in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 283 * 284 * @param journalContentSearch the journal content search 285 * @return the journal content search that was updated 286 */ 287 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 288 public com.liferay.portlet.journal.model.JournalContentSearch updateJournalContentSearch( 289 com.liferay.portlet.journal.model.JournalContentSearch journalContentSearch); 290 }