001 /** 002 * Copyright (c) 2000-present 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.search.IndexableType; 022 import com.liferay.portal.kernel.transaction.Isolation; 023 import com.liferay.portal.kernel.transaction.Propagation; 024 import com.liferay.portal.kernel.transaction.Transactional; 025 026 /** 027 * Provides the local service interface for VirtualHost. Methods of this 028 * service will not have security checks based on the propagated JAAS 029 * credentials because this service can only be accessed from within the same 030 * VM. 031 * 032 * @author Brian Wing Shun Chan 033 * @see VirtualHostLocalServiceUtil 034 * @see com.liferay.portal.service.base.VirtualHostLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.VirtualHostLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface VirtualHostLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * Never modify or reference this interface directly. Always use {@link VirtualHostLocalServiceUtil} to access the virtual host local service. Add custom service methods to {@link com.liferay.portal.service.impl.VirtualHostLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 047 */ 048 049 /** 050 * Adds the virtual host to the database. Also notifies the appropriate model listeners. 051 * 052 * @param virtualHost the virtual host 053 * @return the virtual host that was added 054 */ 055 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 056 public com.liferay.portal.model.VirtualHost addVirtualHost( 057 com.liferay.portal.model.VirtualHost virtualHost); 058 059 /** 060 * Creates a new virtual host with the primary key. Does not add the virtual host to the database. 061 * 062 * @param virtualHostId the primary key for the new virtual host 063 * @return the new virtual host 064 */ 065 public com.liferay.portal.model.VirtualHost createVirtualHost( 066 long virtualHostId); 067 068 /** 069 * @throws PortalException 070 */ 071 @Override 072 public com.liferay.portal.model.PersistedModel deletePersistedModel( 073 com.liferay.portal.model.PersistedModel persistedModel) 074 throws com.liferay.portal.kernel.exception.PortalException; 075 076 /** 077 * Deletes the virtual host from the database. Also notifies the appropriate model listeners. 078 * 079 * @param virtualHost the virtual host 080 * @return the virtual host that was removed 081 */ 082 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 083 public com.liferay.portal.model.VirtualHost deleteVirtualHost( 084 com.liferay.portal.model.VirtualHost virtualHost); 085 086 /** 087 * Deletes the virtual host with the primary key from the database. Also notifies the appropriate model listeners. 088 * 089 * @param virtualHostId the primary key of the virtual host 090 * @return the virtual host that was removed 091 * @throws PortalException if a virtual host with the primary key could not be found 092 */ 093 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 094 public com.liferay.portal.model.VirtualHost deleteVirtualHost( 095 long virtualHostId) 096 throws com.liferay.portal.kernel.exception.PortalException; 097 098 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 099 100 /** 101 * Performs a dynamic query on the database and returns the matching rows. 102 * 103 * @param dynamicQuery the dynamic query 104 * @return the matching rows 105 */ 106 public <T> java.util.List<T> dynamicQuery( 107 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 108 109 /** 110 * Performs a dynamic query on the database and returns a range of the matching rows. 111 * 112 * <p> 113 * 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.VirtualHostModelImpl}. 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. 114 * </p> 115 * 116 * @param dynamicQuery the dynamic query 117 * @param start the lower bound of the range of model instances 118 * @param end the upper bound of the range of model instances (not inclusive) 119 * @return the range of matching rows 120 */ 121 public <T> java.util.List<T> dynamicQuery( 122 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 123 int end); 124 125 /** 126 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 127 * 128 * <p> 129 * 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.VirtualHostModelImpl}. 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. 130 * </p> 131 * 132 * @param dynamicQuery the dynamic query 133 * @param start the lower bound of the range of model instances 134 * @param end the upper bound of the range of model instances (not inclusive) 135 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 136 * @return the ordered range of matching rows 137 */ 138 public <T> java.util.List<T> dynamicQuery( 139 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 140 int end, 141 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 142 143 /** 144 * Returns the number of rows matching the dynamic query. 145 * 146 * @param dynamicQuery the dynamic query 147 * @return the number of rows matching the dynamic query 148 */ 149 public long dynamicQueryCount( 150 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 151 152 /** 153 * Returns the number of rows matching the dynamic query. 154 * 155 * @param dynamicQuery the dynamic query 156 * @param projection the projection to apply to the query 157 * @return the number of rows matching the dynamic query 158 */ 159 public long dynamicQueryCount( 160 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 161 com.liferay.portal.kernel.dao.orm.Projection projection); 162 163 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 164 public com.liferay.portal.model.VirtualHost fetchVirtualHost( 165 long companyId, long layoutSetId); 166 167 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 168 public com.liferay.portal.model.VirtualHost fetchVirtualHost( 169 java.lang.String hostname); 170 171 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 172 public com.liferay.portal.model.VirtualHost fetchVirtualHost( 173 long virtualHostId); 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 177 178 /** 179 * Returns the Spring bean ID for this bean. 180 * 181 * @return the Spring bean ID for this bean 182 */ 183 public java.lang.String getBeanIdentifier(); 184 185 @Override 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public com.liferay.portal.model.PersistedModel getPersistedModel( 188 java.io.Serializable primaryKeyObj) 189 throws com.liferay.portal.kernel.exception.PortalException; 190 191 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 192 public com.liferay.portal.model.VirtualHost getVirtualHost(long companyId, 193 long layoutSetId) 194 throws com.liferay.portal.kernel.exception.PortalException; 195 196 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 197 public com.liferay.portal.model.VirtualHost getVirtualHost( 198 java.lang.String hostname) 199 throws com.liferay.portal.kernel.exception.PortalException; 200 201 /** 202 * Returns the virtual host with the primary key. 203 * 204 * @param virtualHostId the primary key of the virtual host 205 * @return the virtual host 206 * @throws PortalException if a virtual host with the primary key could not be found 207 */ 208 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 209 public com.liferay.portal.model.VirtualHost getVirtualHost( 210 long virtualHostId) 211 throws com.liferay.portal.kernel.exception.PortalException; 212 213 /** 214 * Returns a range of all the virtual hosts. 215 * 216 * <p> 217 * 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.VirtualHostModelImpl}. 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. 218 * </p> 219 * 220 * @param start the lower bound of the range of virtual hosts 221 * @param end the upper bound of the range of virtual hosts (not inclusive) 222 * @return the range of virtual hosts 223 */ 224 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 225 public java.util.List<com.liferay.portal.model.VirtualHost> getVirtualHosts( 226 int start, int end); 227 228 /** 229 * Returns the number of virtual hosts. 230 * 231 * @return the number of virtual hosts 232 */ 233 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 234 public int getVirtualHostsCount(); 235 236 /** 237 * Sets the Spring bean ID for this bean. 238 * 239 * @param beanIdentifier the Spring bean ID for this bean 240 */ 241 public void setBeanIdentifier(java.lang.String beanIdentifier); 242 243 public com.liferay.portal.model.VirtualHost updateVirtualHost( 244 long companyId, long layoutSetId, java.lang.String hostname); 245 246 /** 247 * Updates the virtual host in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 248 * 249 * @param virtualHost the virtual host 250 * @return the virtual host that was updated 251 */ 252 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 253 public com.liferay.portal.model.VirtualHost updateVirtualHost( 254 com.liferay.portal.model.VirtualHost virtualHost); 255 }