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