001    /**
002     * Copyright (c) 2000-2013 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 com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.ReferenceRegistry;
019    
020    /**
021     * The utility for the d d m structure link local service. This utility wraps {@link com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLinkLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
022     *
023     * <p>
024     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
025     * </p>
026     *
027     * @author Brian Wing Shun Chan
028     * @see DDMStructureLinkLocalService
029     * @see com.liferay.portlet.dynamicdatamapping.service.base.DDMStructureLinkLocalServiceBaseImpl
030     * @see com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLinkLocalServiceImpl
031     * @generated
032     */
033    public class DDMStructureLinkLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLinkLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the d d m structure link to the database. Also notifies the appropriate model listeners.
042            *
043            * @param ddmStructureLink the d d m structure link
044            * @return the d d m structure link that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink addDDMStructureLink(
048                    com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink ddmStructureLink)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addDDMStructureLink(ddmStructureLink);
051            }
052    
053            /**
054            * Creates a new d d m structure link with the primary key. Does not add the d d m structure link to the database.
055            *
056            * @param structureLinkId the primary key for the new d d m structure link
057            * @return the new d d m structure link
058            */
059            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink createDDMStructureLink(
060                    long structureLinkId) {
061                    return getService().createDDMStructureLink(structureLinkId);
062            }
063    
064            /**
065            * Deletes the d d m structure link with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param structureLinkId the primary key of the d d m structure link
068            * @return the d d m structure link that was removed
069            * @throws PortalException if a d d m structure link with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink deleteDDMStructureLink(
073                    long structureLinkId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteDDMStructureLink(structureLinkId);
077            }
078    
079            /**
080            * Deletes the d d m structure link from the database. Also notifies the appropriate model listeners.
081            *
082            * @param ddmStructureLink the d d m structure link
083            * @return the d d m structure link that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink deleteDDMStructureLink(
087                    com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink ddmStructureLink)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteDDMStructureLink(ddmStructureLink);
090            }
091    
092            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
093                    return getService().dynamicQuery();
094            }
095    
096            /**
097            * Performs a dynamic query on the database and returns the matching rows.
098            *
099            * @param dynamicQuery the dynamic query
100            * @return the matching rows
101            * @throws SystemException if a system exception occurred
102            */
103            @SuppressWarnings("rawtypes")
104            public static java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException {
107                    return getService().dynamicQuery(dynamicQuery);
108            }
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.
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            * @throws SystemException if a system exception occurred
122            */
123            @SuppressWarnings("rawtypes")
124            public static java.util.List dynamicQuery(
125                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126                    int end) throws com.liferay.portal.kernel.exception.SystemException {
127                    return getService().dynamicQuery(dynamicQuery, start, end);
128            }
129    
130            /**
131            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
132            *
133            * <p>
134            * 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.
135            * </p>
136            *
137            * @param dynamicQuery the dynamic query
138            * @param start the lower bound of the range of model instances
139            * @param end the upper bound of the range of model instances (not inclusive)
140            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
141            * @return the ordered range of matching rows
142            * @throws SystemException if a system exception occurred
143            */
144            @SuppressWarnings("rawtypes")
145            public static java.util.List dynamicQuery(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
147                    int end,
148                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
149                    throws com.liferay.portal.kernel.exception.SystemException {
150                    return getService()
151                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
152            }
153    
154            /**
155            * Returns the number of rows that match the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @return the number of rows that match the dynamic query
159            * @throws SystemException if a system exception occurred
160            */
161            public static long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().dynamicQueryCount(dynamicQuery);
165            }
166    
167            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink fetchDDMStructureLink(
168                    long structureLinkId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchDDMStructureLink(structureLinkId);
171            }
172    
173            /**
174            * Returns the d d m structure link with the primary key.
175            *
176            * @param structureLinkId the primary key of the d d m structure link
177            * @return the d d m structure link
178            * @throws PortalException if a d d m structure link with the primary key could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink getDDMStructureLink(
182                    long structureLinkId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getDDMStructureLink(structureLinkId);
186            }
187    
188            public static com.liferay.portal.model.PersistedModel getPersistedModel(
189                    java.io.Serializable primaryKeyObj)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException {
192                    return getService().getPersistedModel(primaryKeyObj);
193            }
194    
195            /**
196            * Returns a range of all the d d m structure links.
197            *
198            * <p>
199            * 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.
200            * </p>
201            *
202            * @param start the lower bound of the range of d d m structure links
203            * @param end the upper bound of the range of d d m structure links (not inclusive)
204            * @return the range of d d m structure links
205            * @throws SystemException if a system exception occurred
206            */
207            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink> getDDMStructureLinks(
208                    int start, int end)
209                    throws com.liferay.portal.kernel.exception.SystemException {
210                    return getService().getDDMStructureLinks(start, end);
211            }
212    
213            /**
214            * Returns the number of d d m structure links.
215            *
216            * @return the number of d d m structure links
217            * @throws SystemException if a system exception occurred
218            */
219            public static int getDDMStructureLinksCount()
220                    throws com.liferay.portal.kernel.exception.SystemException {
221                    return getService().getDDMStructureLinksCount();
222            }
223    
224            /**
225            * Updates the d d m structure link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
226            *
227            * @param ddmStructureLink the d d m structure link
228            * @return the d d m structure link that was updated
229            * @throws SystemException if a system exception occurred
230            */
231            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink updateDDMStructureLink(
232                    com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink ddmStructureLink)
233                    throws com.liferay.portal.kernel.exception.SystemException {
234                    return getService().updateDDMStructureLink(ddmStructureLink);
235            }
236    
237            /**
238            * Updates the d d m structure link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
239            *
240            * @param ddmStructureLink the d d m structure link
241            * @param merge whether to merge the d d m structure link with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
242            * @return the d d m structure link that was updated
243            * @throws SystemException if a system exception occurred
244            */
245            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink updateDDMStructureLink(
246                    com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink ddmStructureLink,
247                    boolean merge)
248                    throws com.liferay.portal.kernel.exception.SystemException {
249                    return getService().updateDDMStructureLink(ddmStructureLink, merge);
250            }
251    
252            /**
253            * Returns the Spring bean ID for this bean.
254            *
255            * @return the Spring bean ID for this bean
256            */
257            public static java.lang.String getBeanIdentifier() {
258                    return getService().getBeanIdentifier();
259            }
260    
261            /**
262            * Sets the Spring bean ID for this bean.
263            *
264            * @param beanIdentifier the Spring bean ID for this bean
265            */
266            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
267                    getService().setBeanIdentifier(beanIdentifier);
268            }
269    
270            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink addStructureLink(
271                    long classNameId, long classPK, long structureId,
272                    com.liferay.portal.service.ServiceContext serviceContext)
273                    throws com.liferay.portal.kernel.exception.SystemException {
274                    return getService()
275                                       .addStructureLink(classNameId, classPK, structureId,
276                            serviceContext);
277            }
278    
279            public static void deleteClassStructureLink(long classPK)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException {
282                    getService().deleteClassStructureLink(classPK);
283            }
284    
285            public static void deleteStructureLink(
286                    com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink structureLink)
287                    throws com.liferay.portal.kernel.exception.SystemException {
288                    getService().deleteStructureLink(structureLink);
289            }
290    
291            public static void deleteStructureLink(long structureLinkId)
292                    throws com.liferay.portal.kernel.exception.PortalException,
293                            com.liferay.portal.kernel.exception.SystemException {
294                    getService().deleteStructureLink(structureLinkId);
295            }
296    
297            public static void deleteStructureStructureLinks(long structureId)
298                    throws com.liferay.portal.kernel.exception.SystemException {
299                    getService().deleteStructureStructureLinks(structureId);
300            }
301    
302            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink getClassStructureLink(
303                    long classPK)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException {
306                    return getService().getClassStructureLink(classPK);
307            }
308    
309            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink> getClassStructureLinks(
310                    long classNameId)
311                    throws com.liferay.portal.kernel.exception.SystemException {
312                    return getService().getClassStructureLinks(classNameId);
313            }
314    
315            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink getStructureLink(
316                    long structureLinkId)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException {
319                    return getService().getStructureLink(structureLinkId);
320            }
321    
322            public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink> getStructureLinks(
323                    long structureId, int start, int end)
324                    throws com.liferay.portal.kernel.exception.SystemException {
325                    return getService().getStructureLinks(structureId, start, end);
326            }
327    
328            public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureLink updateStructureLink(
329                    long structureLinkId, long classNameId, long classPK, long structureId)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException {
332                    return getService()
333                                       .updateStructureLink(structureLinkId, classNameId, classPK,
334                            structureId);
335            }
336    
337            public static DDMStructureLinkLocalService getService() {
338                    if (_service == null) {
339                            _service = (DDMStructureLinkLocalService)PortalBeanLocatorUtil.locate(DDMStructureLinkLocalService.class.getName());
340    
341                            ReferenceRegistry.registerReference(DDMStructureLinkLocalServiceUtil.class,
342                                    "_service");
343                    }
344    
345                    return _service;
346            }
347    
348            /**
349             * @deprecated
350             */
351            public void setService(DDMStructureLinkLocalService service) {
352            }
353    
354            private static DDMStructureLinkLocalService _service;
355    }