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.WebDAVProps;
033    
034    import java.io.Serializable;
035    
036    import java.util.List;
037    
038    /**
039     * Provides the local service interface for WebDAVProps. 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 WebDAVPropsLocalServiceUtil
046     * @see com.liferay.portal.service.base.WebDAVPropsLocalServiceBaseImpl
047     * @see com.liferay.portal.service.impl.WebDAVPropsLocalServiceImpl
048     * @generated
049     */
050    @ProviderType
051    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
052            PortalException.class, SystemException.class})
053    public interface WebDAVPropsLocalService extends BaseLocalService,
054            PersistedModelLocalService {
055            /*
056             * NOTE FOR DEVELOPERS:
057             *
058             * Never modify or reference this interface directly. Always use {@link WebDAVPropsLocalServiceUtil} to access the web d a v props local service. Add custom service methods to {@link com.liferay.portal.service.impl.WebDAVPropsLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
059             */
060    
061            /**
062            * Adds the web d a v props to the database. Also notifies the appropriate model listeners.
063            *
064            * @param webDAVProps the web d a v props
065            * @return the web d a v props that was added
066            */
067            @Indexable(type = IndexableType.REINDEX)
068            public WebDAVProps addWebDAVProps(WebDAVProps webDAVProps);
069    
070            /**
071            * Creates a new web d a v props with the primary key. Does not add the web d a v props to the database.
072            *
073            * @param webDavPropsId the primary key for the new web d a v props
074            * @return the new web d a v props
075            */
076            public WebDAVProps createWebDAVProps(long webDavPropsId);
077    
078            /**
079            * @throws PortalException
080            */
081            @Override
082            public PersistedModel deletePersistedModel(PersistedModel persistedModel)
083                    throws PortalException;
084    
085            public void deleteWebDAVProps(java.lang.String className, long classPK);
086    
087            /**
088            * Deletes the web d a v props from the database. Also notifies the appropriate model listeners.
089            *
090            * @param webDAVProps the web d a v props
091            * @return the web d a v props that was removed
092            */
093            @Indexable(type = IndexableType.DELETE)
094            public WebDAVProps deleteWebDAVProps(WebDAVProps webDAVProps);
095    
096            /**
097            * Deletes the web d a v props with the primary key from the database. Also notifies the appropriate model listeners.
098            *
099            * @param webDavPropsId the primary key of the web d a v props
100            * @return the web d a v props that was removed
101            * @throws PortalException if a web d a v props with the primary key could not be found
102            */
103            @Indexable(type = IndexableType.DELETE)
104            public WebDAVProps deleteWebDAVProps(long webDavPropsId)
105                    throws PortalException;
106    
107            public DynamicQuery dynamicQuery();
108    
109            /**
110            * Performs a dynamic query on the database and returns the matching rows.
111            *
112            * @param dynamicQuery the dynamic query
113            * @return the matching rows
114            */
115            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery);
116    
117            /**
118            * Performs a dynamic query on the database and returns a range of the matching rows.
119            *
120            * <p>
121            * 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.WebDAVPropsModelImpl}. 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.
122            * </p>
123            *
124            * @param dynamicQuery the dynamic query
125            * @param start the lower bound of the range of model instances
126            * @param end the upper bound of the range of model instances (not inclusive)
127            * @return the range of matching rows
128            */
129            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
130                    int end);
131    
132            /**
133            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
134            *
135            * <p>
136            * 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.WebDAVPropsModelImpl}. 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.
137            * </p>
138            *
139            * @param dynamicQuery the dynamic query
140            * @param start the lower bound of the range of model instances
141            * @param end the upper bound of the range of model instances (not inclusive)
142            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
143            * @return the ordered range of matching rows
144            */
145            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
146                    int end, OrderByComparator<T> orderByComparator);
147    
148            /**
149            * Returns the number of rows matching the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows matching the dynamic query
153            */
154            public long dynamicQueryCount(DynamicQuery dynamicQuery);
155    
156            /**
157            * Returns the number of rows matching the dynamic query.
158            *
159            * @param dynamicQuery the dynamic query
160            * @param projection the projection to apply to the query
161            * @return the number of rows matching the dynamic query
162            */
163            public long dynamicQueryCount(DynamicQuery dynamicQuery,
164                    Projection projection);
165    
166            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
167            public WebDAVProps fetchWebDAVProps(long webDavPropsId);
168    
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public ActionableDynamicQuery getActionableDynamicQuery();
171    
172            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
173            public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
174    
175            /**
176            * Returns the OSGi service identifier.
177            *
178            * @return the OSGi service identifier
179            */
180            public java.lang.String getOSGiServiceIdentifier();
181    
182            @Override
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public PersistedModel getPersistedModel(Serializable primaryKeyObj)
185                    throws PortalException;
186    
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public WebDAVProps getWebDAVProps(long companyId,
189                    java.lang.String className, long classPK);
190    
191            /**
192            * Returns the web d a v props with the primary key.
193            *
194            * @param webDavPropsId the primary key of the web d a v props
195            * @return the web d a v props
196            * @throws PortalException if a web d a v props with the primary key could not be found
197            */
198            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199            public WebDAVProps getWebDAVProps(long webDavPropsId)
200                    throws PortalException;
201    
202            /**
203            * Returns a range of all the web d a v propses.
204            *
205            * <p>
206            * 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.WebDAVPropsModelImpl}. 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.
207            * </p>
208            *
209            * @param start the lower bound of the range of web d a v propses
210            * @param end the upper bound of the range of web d a v propses (not inclusive)
211            * @return the range of web d a v propses
212            */
213            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
214            public List<WebDAVProps> getWebDAVPropses(int start, int end);
215    
216            /**
217            * Returns the number of web d a v propses.
218            *
219            * @return the number of web d a v propses
220            */
221            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
222            public int getWebDAVPropsesCount();
223    
224            public void storeWebDAVProps(WebDAVProps webDavProps)
225                    throws PortalException;
226    
227            /**
228            * Updates the web d a v props in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
229            *
230            * @param webDAVProps the web d a v props
231            * @return the web d a v props that was updated
232            */
233            @Indexable(type = IndexableType.REINDEX)
234            public WebDAVProps updateWebDAVProps(WebDAVProps webDAVProps);
235    }