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