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