001 /** 002 * Copyright (c) 2000-2012 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 com.liferay.portal.kernel.bean.PortalBeanLocatorUtil; 018 import com.liferay.portal.kernel.util.MethodCache; 019 import com.liferay.portal.kernel.util.ReferenceRegistry; 020 021 /** 022 * The utility for the virtual host local service. This utility wraps {@link com.liferay.portal.service.impl.VirtualHostLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server. 023 * 024 * <p> 025 * 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. 026 * </p> 027 * 028 * @author Brian Wing Shun Chan 029 * @see VirtualHostLocalService 030 * @see com.liferay.portal.service.base.VirtualHostLocalServiceBaseImpl 031 * @see com.liferay.portal.service.impl.VirtualHostLocalServiceImpl 032 * @generated 033 */ 034 public class VirtualHostLocalServiceUtil { 035 /* 036 * NOTE FOR DEVELOPERS: 037 * 038 * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.VirtualHostLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 039 */ 040 041 /** 042 * Adds the virtual host to the database. Also notifies the appropriate model listeners. 043 * 044 * @param virtualHost the virtual host 045 * @return the virtual host that was added 046 * @throws SystemException if a system exception occurred 047 */ 048 public static com.liferay.portal.model.VirtualHost addVirtualHost( 049 com.liferay.portal.model.VirtualHost virtualHost) 050 throws com.liferay.portal.kernel.exception.SystemException { 051 return getService().addVirtualHost(virtualHost); 052 } 053 054 /** 055 * Creates a new virtual host with the primary key. Does not add the virtual host to the database. 056 * 057 * @param virtualHostId the primary key for the new virtual host 058 * @return the new virtual host 059 */ 060 public static com.liferay.portal.model.VirtualHost createVirtualHost( 061 long virtualHostId) { 062 return getService().createVirtualHost(virtualHostId); 063 } 064 065 /** 066 * Deletes the virtual host with the primary key from the database. Also notifies the appropriate model listeners. 067 * 068 * @param virtualHostId the primary key of the virtual host 069 * @throws PortalException if a virtual host with the primary key could not be found 070 * @throws SystemException if a system exception occurred 071 */ 072 public static void deleteVirtualHost(long virtualHostId) 073 throws com.liferay.portal.kernel.exception.PortalException, 074 com.liferay.portal.kernel.exception.SystemException { 075 getService().deleteVirtualHost(virtualHostId); 076 } 077 078 /** 079 * Deletes the virtual host from the database. Also notifies the appropriate model listeners. 080 * 081 * @param virtualHost the virtual host 082 * @throws SystemException if a system exception occurred 083 */ 084 public static void deleteVirtualHost( 085 com.liferay.portal.model.VirtualHost virtualHost) 086 throws com.liferay.portal.kernel.exception.SystemException { 087 getService().deleteVirtualHost(virtualHost); 088 } 089 090 /** 091 * Performs a dynamic query on the database and returns the matching rows. 092 * 093 * @param dynamicQuery the dynamic query 094 * @return the matching rows 095 * @throws SystemException if a system exception occurred 096 */ 097 @SuppressWarnings("rawtypes") 098 public static java.util.List dynamicQuery( 099 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 100 throws com.liferay.portal.kernel.exception.SystemException { 101 return getService().dynamicQuery(dynamicQuery); 102 } 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. 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 static 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 return getService().dynamicQuery(dynamicQuery, start, end); 122 } 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. 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 static 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 return getService() 145 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 146 } 147 148 /** 149 * Returns the number of rows that match the dynamic query. 150 * 151 * @param dynamicQuery the dynamic query 152 * @return the number of rows that match the dynamic query 153 * @throws SystemException if a system exception occurred 154 */ 155 public static long dynamicQueryCount( 156 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 157 throws com.liferay.portal.kernel.exception.SystemException { 158 return getService().dynamicQueryCount(dynamicQuery); 159 } 160 161 public static com.liferay.portal.model.VirtualHost fetchVirtualHost( 162 long virtualHostId) 163 throws com.liferay.portal.kernel.exception.SystemException { 164 return getService().fetchVirtualHost(virtualHostId); 165 } 166 167 /** 168 * Returns the virtual host with the primary key. 169 * 170 * @param virtualHostId the primary key of the virtual host 171 * @return the virtual host 172 * @throws PortalException if a virtual host with the primary key could not be found 173 * @throws SystemException if a system exception occurred 174 */ 175 public static com.liferay.portal.model.VirtualHost getVirtualHost( 176 long virtualHostId) 177 throws com.liferay.portal.kernel.exception.PortalException, 178 com.liferay.portal.kernel.exception.SystemException { 179 return getService().getVirtualHost(virtualHostId); 180 } 181 182 public static com.liferay.portal.model.PersistedModel getPersistedModel( 183 java.io.Serializable primaryKeyObj) 184 throws com.liferay.portal.kernel.exception.PortalException, 185 com.liferay.portal.kernel.exception.SystemException { 186 return getService().getPersistedModel(primaryKeyObj); 187 } 188 189 /** 190 * Returns a range of all the virtual hosts. 191 * 192 * <p> 193 * 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. 194 * </p> 195 * 196 * @param start the lower bound of the range of virtual hosts 197 * @param end the upper bound of the range of virtual hosts (not inclusive) 198 * @return the range of virtual hosts 199 * @throws SystemException if a system exception occurred 200 */ 201 public static java.util.List<com.liferay.portal.model.VirtualHost> getVirtualHosts( 202 int start, int end) 203 throws com.liferay.portal.kernel.exception.SystemException { 204 return getService().getVirtualHosts(start, end); 205 } 206 207 /** 208 * Returns the number of virtual hosts. 209 * 210 * @return the number of virtual hosts 211 * @throws SystemException if a system exception occurred 212 */ 213 public static int getVirtualHostsCount() 214 throws com.liferay.portal.kernel.exception.SystemException { 215 return getService().getVirtualHostsCount(); 216 } 217 218 /** 219 * Updates the virtual host in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 220 * 221 * @param virtualHost the virtual host 222 * @return the virtual host that was updated 223 * @throws SystemException if a system exception occurred 224 */ 225 public static com.liferay.portal.model.VirtualHost updateVirtualHost( 226 com.liferay.portal.model.VirtualHost virtualHost) 227 throws com.liferay.portal.kernel.exception.SystemException { 228 return getService().updateVirtualHost(virtualHost); 229 } 230 231 /** 232 * Updates the virtual host in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 233 * 234 * @param virtualHost the virtual host 235 * @param merge whether to merge the virtual host with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation. 236 * @return the virtual host that was updated 237 * @throws SystemException if a system exception occurred 238 */ 239 public static com.liferay.portal.model.VirtualHost updateVirtualHost( 240 com.liferay.portal.model.VirtualHost virtualHost, boolean merge) 241 throws com.liferay.portal.kernel.exception.SystemException { 242 return getService().updateVirtualHost(virtualHost, merge); 243 } 244 245 /** 246 * Returns the Spring bean ID for this bean. 247 * 248 * @return the Spring bean ID for this bean 249 */ 250 public static java.lang.String getBeanIdentifier() { 251 return getService().getBeanIdentifier(); 252 } 253 254 /** 255 * Sets the Spring bean ID for this bean. 256 * 257 * @param beanIdentifier the Spring bean ID for this bean 258 */ 259 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 260 getService().setBeanIdentifier(beanIdentifier); 261 } 262 263 public static com.liferay.portal.model.VirtualHost fetchVirtualHost( 264 long companyId, long layoutSetId) 265 throws com.liferay.portal.kernel.exception.SystemException { 266 return getService().fetchVirtualHost(companyId, layoutSetId); 267 } 268 269 public static com.liferay.portal.model.VirtualHost fetchVirtualHost( 270 java.lang.String hostname) 271 throws com.liferay.portal.kernel.exception.SystemException { 272 return getService().fetchVirtualHost(hostname); 273 } 274 275 public static com.liferay.portal.model.VirtualHost getVirtualHost( 276 long companyId, long layoutSetId) 277 throws com.liferay.portal.kernel.exception.PortalException, 278 com.liferay.portal.kernel.exception.SystemException { 279 return getService().getVirtualHost(companyId, layoutSetId); 280 } 281 282 public static com.liferay.portal.model.VirtualHost getVirtualHost( 283 java.lang.String hostname) 284 throws com.liferay.portal.kernel.exception.PortalException, 285 com.liferay.portal.kernel.exception.SystemException { 286 return getService().getVirtualHost(hostname); 287 } 288 289 public static com.liferay.portal.model.VirtualHost updateVirtualHost( 290 long companyId, long layoutSetId, java.lang.String hostname) 291 throws com.liferay.portal.kernel.exception.SystemException { 292 return getService().updateVirtualHost(companyId, layoutSetId, hostname); 293 } 294 295 public static VirtualHostLocalService getService() { 296 if (_service == null) { 297 _service = (VirtualHostLocalService)PortalBeanLocatorUtil.locate(VirtualHostLocalService.class.getName()); 298 299 ReferenceRegistry.registerReference(VirtualHostLocalServiceUtil.class, 300 "_service"); 301 MethodCache.remove(VirtualHostLocalService.class); 302 } 303 304 return _service; 305 } 306 307 public void setService(VirtualHostLocalService service) { 308 MethodCache.remove(VirtualHostLocalService.class); 309 310 _service = service; 311 312 ReferenceRegistry.registerReference(VirtualHostLocalServiceUtil.class, 313 "_service"); 314 MethodCache.remove(VirtualHostLocalService.class); 315 } 316 317 private static VirtualHostLocalService _service; 318 }