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