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