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