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.portal.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 025 /** 026 * Provides the local service interface for Website. 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 WebsiteLocalServiceUtil 033 * @see com.liferay.portal.service.base.WebsiteLocalServiceBaseImpl 034 * @see com.liferay.portal.service.impl.WebsiteLocalServiceImpl 035 * @generated 036 */ 037 @ProviderType 038 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 039 PortalException.class, SystemException.class}) 040 public interface WebsiteLocalService extends BaseLocalService, 041 PersistedModelLocalService { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * Never modify or reference this interface directly. Always use {@link WebsiteLocalServiceUtil} to access the website local service. Add custom service methods to {@link com.liferay.portal.service.impl.WebsiteLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 046 */ 047 048 /** 049 * Adds the website to the database. Also notifies the appropriate model listeners. 050 * 051 * @param website the website 052 * @return the website that was added 053 * @throws SystemException if a system exception occurred 054 */ 055 public com.liferay.portal.model.Website addWebsite( 056 com.liferay.portal.model.Website website) 057 throws com.liferay.portal.kernel.exception.SystemException; 058 059 /** 060 * Creates a new website with the primary key. Does not add the website to the database. 061 * 062 * @param websiteId the primary key for the new website 063 * @return the new website 064 */ 065 public com.liferay.portal.model.Website createWebsite(long websiteId); 066 067 /** 068 * Deletes the website with the primary key from the database. Also notifies the appropriate model listeners. 069 * 070 * @param websiteId the primary key of the website 071 * @return the website that was removed 072 * @throws PortalException if a website with the primary key could not be found 073 * @throws SystemException if a system exception occurred 074 */ 075 public com.liferay.portal.model.Website deleteWebsite(long websiteId) 076 throws com.liferay.portal.kernel.exception.PortalException, 077 com.liferay.portal.kernel.exception.SystemException; 078 079 /** 080 * Deletes the website from the database. Also notifies the appropriate model listeners. 081 * 082 * @param website the website 083 * @return the website that was removed 084 * @throws SystemException if a system exception occurred 085 */ 086 public com.liferay.portal.model.Website deleteWebsite( 087 com.liferay.portal.model.Website website) 088 throws com.liferay.portal.kernel.exception.SystemException; 089 090 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 091 092 /** 093 * Performs a dynamic query on the database and returns the matching rows. 094 * 095 * @param dynamicQuery the dynamic query 096 * @return the matching rows 097 * @throws SystemException if a system exception occurred 098 */ 099 @SuppressWarnings("rawtypes") 100 public java.util.List dynamicQuery( 101 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 102 throws com.liferay.portal.kernel.exception.SystemException; 103 104 /** 105 * Performs a dynamic query on the database and returns a range of the matching rows. 106 * 107 * <p> 108 * 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.portal.model.impl.WebsiteModelImpl}. 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. 109 * </p> 110 * 111 * @param dynamicQuery the dynamic query 112 * @param start the lower bound of the range of model instances 113 * @param end the upper bound of the range of model instances (not inclusive) 114 * @return the range of matching rows 115 * @throws SystemException if a system exception occurred 116 */ 117 @SuppressWarnings("rawtypes") 118 public java.util.List dynamicQuery( 119 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 120 int end) throws com.liferay.portal.kernel.exception.SystemException; 121 122 /** 123 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 124 * 125 * <p> 126 * 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.portal.model.impl.WebsiteModelImpl}. 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. 127 * </p> 128 * 129 * @param dynamicQuery the dynamic query 130 * @param start the lower bound of the range of model instances 131 * @param end the upper bound of the range of model instances (not inclusive) 132 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 133 * @return the ordered range of matching rows 134 * @throws SystemException if a system exception occurred 135 */ 136 @SuppressWarnings("rawtypes") 137 public java.util.List dynamicQuery( 138 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 139 int end, 140 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 141 throws com.liferay.portal.kernel.exception.SystemException; 142 143 /** 144 * Returns the number of rows that match the dynamic query. 145 * 146 * @param dynamicQuery the dynamic query 147 * @return the number of rows that match the dynamic query 148 * @throws SystemException if a system exception occurred 149 */ 150 public long dynamicQueryCount( 151 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 152 throws com.liferay.portal.kernel.exception.SystemException; 153 154 /** 155 * Returns the number of rows that match the dynamic query. 156 * 157 * @param dynamicQuery the dynamic query 158 * @param projection the projection to apply to the query 159 * @return the number of rows that match the dynamic query 160 * @throws SystemException if a system exception occurred 161 */ 162 public long dynamicQueryCount( 163 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 164 com.liferay.portal.kernel.dao.orm.Projection projection) 165 throws com.liferay.portal.kernel.exception.SystemException; 166 167 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 168 public com.liferay.portal.model.Website fetchWebsite(long websiteId) 169 throws com.liferay.portal.kernel.exception.SystemException; 170 171 /** 172 * Returns the website with the matching UUID and company. 173 * 174 * @param uuid the website's UUID 175 * @param companyId the primary key of the company 176 * @return the matching website, or <code>null</code> if a matching website could not be found 177 * @throws SystemException if a system exception occurred 178 */ 179 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 180 public com.liferay.portal.model.Website fetchWebsiteByUuidAndCompanyId( 181 java.lang.String uuid, long companyId) 182 throws com.liferay.portal.kernel.exception.SystemException; 183 184 /** 185 * Returns the website with the primary key. 186 * 187 * @param websiteId the primary key of the website 188 * @return the website 189 * @throws PortalException if a website with the primary key could not be found 190 * @throws SystemException if a system exception occurred 191 */ 192 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 193 public com.liferay.portal.model.Website getWebsite(long websiteId) 194 throws com.liferay.portal.kernel.exception.PortalException, 195 com.liferay.portal.kernel.exception.SystemException; 196 197 @Override 198 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 199 public com.liferay.portal.model.PersistedModel getPersistedModel( 200 java.io.Serializable primaryKeyObj) 201 throws com.liferay.portal.kernel.exception.PortalException, 202 com.liferay.portal.kernel.exception.SystemException; 203 204 /** 205 * Returns the website with the matching UUID and company. 206 * 207 * @param uuid the website's UUID 208 * @param companyId the primary key of the company 209 * @return the matching website 210 * @throws PortalException if a matching website could not be found 211 * @throws SystemException if a system exception occurred 212 */ 213 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 214 public com.liferay.portal.model.Website getWebsiteByUuidAndCompanyId( 215 java.lang.String uuid, long companyId) 216 throws com.liferay.portal.kernel.exception.PortalException, 217 com.liferay.portal.kernel.exception.SystemException; 218 219 /** 220 * Returns a range of all the websites. 221 * 222 * <p> 223 * 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.portal.model.impl.WebsiteModelImpl}. 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. 224 * </p> 225 * 226 * @param start the lower bound of the range of websites 227 * @param end the upper bound of the range of websites (not inclusive) 228 * @return the range of websites 229 * @throws SystemException if a system exception occurred 230 */ 231 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 232 public java.util.List<com.liferay.portal.model.Website> getWebsites( 233 int start, int end) 234 throws com.liferay.portal.kernel.exception.SystemException; 235 236 /** 237 * Returns the number of websites. 238 * 239 * @return the number of websites 240 * @throws SystemException if a system exception occurred 241 */ 242 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 243 public int getWebsitesCount() 244 throws com.liferay.portal.kernel.exception.SystemException; 245 246 /** 247 * Updates the website in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 248 * 249 * @param website the website 250 * @return the website that was updated 251 * @throws SystemException if a system exception occurred 252 */ 253 public com.liferay.portal.model.Website updateWebsite( 254 com.liferay.portal.model.Website website) 255 throws com.liferay.portal.kernel.exception.SystemException; 256 257 /** 258 * Returns the Spring bean ID for this bean. 259 * 260 * @return the Spring bean ID for this bean 261 */ 262 public java.lang.String getBeanIdentifier(); 263 264 /** 265 * Sets the Spring bean ID for this bean. 266 * 267 * @param beanIdentifier the Spring bean ID for this bean 268 */ 269 public void setBeanIdentifier(java.lang.String beanIdentifier); 270 271 /** 272 * @deprecated As of 6.2.0, replaced by {@link #addWebsite(long, String, 273 long, String, int, boolean, ServiceContext)} 274 */ 275 public com.liferay.portal.model.Website addWebsite(long userId, 276 java.lang.String className, long classPK, java.lang.String url, 277 int typeId, boolean primary) 278 throws com.liferay.portal.kernel.exception.PortalException, 279 com.liferay.portal.kernel.exception.SystemException; 280 281 public com.liferay.portal.model.Website addWebsite(long userId, 282 java.lang.String className, long classPK, java.lang.String url, 283 int typeId, boolean primary, 284 com.liferay.portal.service.ServiceContext serviceContext) 285 throws com.liferay.portal.kernel.exception.PortalException, 286 com.liferay.portal.kernel.exception.SystemException; 287 288 public void deleteWebsites(long companyId, java.lang.String className, 289 long classPK) 290 throws com.liferay.portal.kernel.exception.SystemException; 291 292 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 293 public java.util.List<com.liferay.portal.model.Website> getWebsites() 294 throws com.liferay.portal.kernel.exception.SystemException; 295 296 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 297 public java.util.List<com.liferay.portal.model.Website> getWebsites( 298 long companyId, java.lang.String className, long classPK) 299 throws com.liferay.portal.kernel.exception.SystemException; 300 301 public com.liferay.portal.model.Website updateWebsite(long websiteId, 302 java.lang.String url, int typeId, boolean primary) 303 throws com.liferay.portal.kernel.exception.PortalException, 304 com.liferay.portal.kernel.exception.SystemException; 305 }