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