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