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