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