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