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.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.search.Indexable;
026    import com.liferay.portal.kernel.search.IndexableType;
027    import com.liferay.portal.kernel.transaction.Isolation;
028    import com.liferay.portal.kernel.transaction.Propagation;
029    import com.liferay.portal.kernel.transaction.Transactional;
030    import com.liferay.portal.kernel.util.OrderByComparator;
031    import com.liferay.portal.model.PersistedModel;
032    import com.liferay.portal.model.VirtualHost;
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    
061            /**
062            * Adds the virtual host to the database. Also notifies the appropriate model listeners.
063            *
064            * @param virtualHost the virtual host
065            * @return the virtual host that was added
066            */
067            @Indexable(type = IndexableType.REINDEX)
068            public VirtualHost addVirtualHost(VirtualHost virtualHost);
069    
070            /**
071            * Creates a new virtual host with the primary key. Does not add the virtual host to the database.
072            *
073            * @param virtualHostId the primary key for the new virtual host
074            * @return the new virtual host
075            */
076            public VirtualHost createVirtualHost(long virtualHostId);
077    
078            /**
079            * @throws PortalException
080            */
081            @Override
082            public PersistedModel deletePersistedModel(PersistedModel persistedModel)
083                    throws PortalException;
084    
085            /**
086            * Deletes the virtual host from the database. Also notifies the appropriate model listeners.
087            *
088            * @param virtualHost the virtual host
089            * @return the virtual host that was removed
090            */
091            @Indexable(type = IndexableType.DELETE)
092            public VirtualHost deleteVirtualHost(VirtualHost virtualHost);
093    
094            /**
095            * Deletes the virtual host with the primary key from the database. Also notifies the appropriate model listeners.
096            *
097            * @param virtualHostId the primary key of the virtual host
098            * @return the virtual host that was removed
099            * @throws PortalException if a virtual host with the primary key could not be found
100            */
101            @Indexable(type = IndexableType.DELETE)
102            public VirtualHost deleteVirtualHost(long virtualHostId)
103                    throws PortalException;
104    
105            public DynamicQuery dynamicQuery();
106    
107            /**
108            * Performs a dynamic query on the database and returns the matching rows.
109            *
110            * @param dynamicQuery the dynamic query
111            * @return the matching rows
112            */
113            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery);
114    
115            /**
116            * Performs a dynamic query on the database and returns a range of the matching rows.
117            *
118            * <p>
119            * 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.
120            * </p>
121            *
122            * @param dynamicQuery the dynamic query
123            * @param start the lower bound of the range of model instances
124            * @param end the upper bound of the range of model instances (not inclusive)
125            * @return the range of matching rows
126            */
127            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
128                    int end);
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. 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.
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            */
143            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
144                    int end, OrderByComparator<T> orderByComparator);
145    
146            /**
147            * Returns the number of rows matching the dynamic query.
148            *
149            * @param dynamicQuery the dynamic query
150            * @return the number of rows matching the dynamic query
151            */
152            public long dynamicQueryCount(DynamicQuery dynamicQuery);
153    
154            /**
155            * Returns the number of rows matching 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 matching the dynamic query
160            */
161            public long dynamicQueryCount(DynamicQuery dynamicQuery,
162                    Projection projection);
163    
164            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
165            public VirtualHost fetchVirtualHost(long companyId, long layoutSetId);
166    
167            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
168            public VirtualHost fetchVirtualHost(java.lang.String hostname);
169    
170            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
171            public VirtualHost fetchVirtualHost(long virtualHostId);
172    
173            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174            public ActionableDynamicQuery getActionableDynamicQuery();
175    
176            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
177            public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
178    
179            /**
180            * Returns the OSGi service identifier.
181            *
182            * @return the OSGi service identifier
183            */
184            public java.lang.String getOSGiServiceIdentifier();
185    
186            @Override
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public PersistedModel getPersistedModel(Serializable primaryKeyObj)
189                    throws PortalException;
190    
191            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
192            public VirtualHost getVirtualHost(long companyId, long layoutSetId)
193                    throws PortalException;
194    
195            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
196            public VirtualHost getVirtualHost(java.lang.String hostname)
197                    throws PortalException;
198    
199            /**
200            * Returns the virtual host with the primary key.
201            *
202            * @param virtualHostId the primary key of the virtual host
203            * @return the virtual host
204            * @throws PortalException if a virtual host with the primary key could not be found
205            */
206            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
207            public VirtualHost getVirtualHost(long virtualHostId)
208                    throws PortalException;
209    
210            /**
211            * Returns a range of all the virtual hosts.
212            *
213            * <p>
214            * 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.
215            * </p>
216            *
217            * @param start the lower bound of the range of virtual hosts
218            * @param end the upper bound of the range of virtual hosts (not inclusive)
219            * @return the range of virtual hosts
220            */
221            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
222            public List<VirtualHost> getVirtualHosts(int start, int end);
223    
224            /**
225            * Returns the number of virtual hosts.
226            *
227            * @return the number of virtual hosts
228            */
229            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
230            public int getVirtualHostsCount();
231    
232            public VirtualHost updateVirtualHost(long companyId, long layoutSetId,
233                    java.lang.String hostname);
234    
235            /**
236            * Updates the virtual host in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
237            *
238            * @param virtualHost the virtual host
239            * @return the virtual host that was updated
240            */
241            @Indexable(type = IndexableType.REINDEX)
242            public VirtualHost updateVirtualHost(VirtualHost virtualHost);
243    }