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.journal.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 journal structure local service. This utility wraps {@link com.liferay.portlet.journal.service.impl.JournalStructureLocalServiceImpl} 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 JournalStructureLocalService
029     * @see com.liferay.portlet.journal.service.base.JournalStructureLocalServiceBaseImpl
030     * @see com.liferay.portlet.journal.service.impl.JournalStructureLocalServiceImpl
031     * @generated
032     */
033    public class JournalStructureLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalStructureLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the journal structure to the database. Also notifies the appropriate model listeners.
042            *
043            * @param journalStructure the journal structure
044            * @return the journal structure that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.journal.model.JournalStructure addJournalStructure(
048                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addJournalStructure(journalStructure);
051            }
052    
053            /**
054            * Creates a new journal structure with the primary key. Does not add the journal structure to the database.
055            *
056            * @param id the primary key for the new journal structure
057            * @return the new journal structure
058            */
059            public static com.liferay.portlet.journal.model.JournalStructure createJournalStructure(
060                    long id) {
061                    return getService().createJournalStructure(id);
062            }
063    
064            /**
065            * Deletes the journal structure with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param id the primary key of the journal structure
068            * @return the journal structure that was removed
069            * @throws PortalException if a journal structure with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portlet.journal.model.JournalStructure deleteJournalStructure(
073                    long id)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteJournalStructure(id);
077            }
078    
079            /**
080            * Deletes the journal structure from the database. Also notifies the appropriate model listeners.
081            *
082            * @param journalStructure the journal structure
083            * @return the journal structure that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.journal.model.JournalStructure deleteJournalStructure(
087                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteJournalStructure(journalStructure);
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.journal.model.JournalStructure fetchJournalStructure(
168                    long id) throws com.liferay.portal.kernel.exception.SystemException {
169                    return getService().fetchJournalStructure(id);
170            }
171    
172            /**
173            * Returns the journal structure with the primary key.
174            *
175            * @param id the primary key of the journal structure
176            * @return the journal structure
177            * @throws PortalException if a journal structure with the primary key could not be found
178            * @throws SystemException if a system exception occurred
179            */
180            public static com.liferay.portlet.journal.model.JournalStructure getJournalStructure(
181                    long id)
182                    throws com.liferay.portal.kernel.exception.PortalException,
183                            com.liferay.portal.kernel.exception.SystemException {
184                    return getService().getJournalStructure(id);
185            }
186    
187            public static com.liferay.portal.model.PersistedModel getPersistedModel(
188                    java.io.Serializable primaryKeyObj)
189                    throws com.liferay.portal.kernel.exception.PortalException,
190                            com.liferay.portal.kernel.exception.SystemException {
191                    return getService().getPersistedModel(primaryKeyObj);
192            }
193    
194            /**
195            * Returns the journal structure with the UUID in the group.
196            *
197            * @param uuid the UUID of journal structure
198            * @param groupId the group id of the journal structure
199            * @return the journal structure
200            * @throws PortalException if a journal structure with the UUID in the group could not be found
201            * @throws SystemException if a system exception occurred
202            */
203            public static com.liferay.portlet.journal.model.JournalStructure getJournalStructureByUuidAndGroupId(
204                    java.lang.String uuid, long groupId)
205                    throws com.liferay.portal.kernel.exception.PortalException,
206                            com.liferay.portal.kernel.exception.SystemException {
207                    return getService().getJournalStructureByUuidAndGroupId(uuid, groupId);
208            }
209    
210            /**
211            * Returns a range of all the journal structures.
212            *
213            * <p>
214            * 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.
215            * </p>
216            *
217            * @param start the lower bound of the range of journal structures
218            * @param end the upper bound of the range of journal structures (not inclusive)
219            * @return the range of journal structures
220            * @throws SystemException if a system exception occurred
221            */
222            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getJournalStructures(
223                    int start, int end)
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getJournalStructures(start, end);
226            }
227    
228            /**
229            * Returns the number of journal structures.
230            *
231            * @return the number of journal structures
232            * @throws SystemException if a system exception occurred
233            */
234            public static int getJournalStructuresCount()
235                    throws com.liferay.portal.kernel.exception.SystemException {
236                    return getService().getJournalStructuresCount();
237            }
238    
239            /**
240            * Updates the journal structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
241            *
242            * @param journalStructure the journal structure
243            * @return the journal structure that was updated
244            * @throws SystemException if a system exception occurred
245            */
246            public static com.liferay.portlet.journal.model.JournalStructure updateJournalStructure(
247                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
248                    throws com.liferay.portal.kernel.exception.SystemException {
249                    return getService().updateJournalStructure(journalStructure);
250            }
251    
252            /**
253            * Updates the journal structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
254            *
255            * @param journalStructure the journal structure
256            * @param merge whether to merge the journal structure 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.
257            * @return the journal structure that was updated
258            * @throws SystemException if a system exception occurred
259            */
260            public static com.liferay.portlet.journal.model.JournalStructure updateJournalStructure(
261                    com.liferay.portlet.journal.model.JournalStructure journalStructure,
262                    boolean merge)
263                    throws com.liferay.portal.kernel.exception.SystemException {
264                    return getService().updateJournalStructure(journalStructure, merge);
265            }
266    
267            /**
268            * Returns the Spring bean ID for this bean.
269            *
270            * @return the Spring bean ID for this bean
271            */
272            public static java.lang.String getBeanIdentifier() {
273                    return getService().getBeanIdentifier();
274            }
275    
276            /**
277            * Sets the Spring bean ID for this bean.
278            *
279            * @param beanIdentifier the Spring bean ID for this bean
280            */
281            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
282                    getService().setBeanIdentifier(beanIdentifier);
283            }
284    
285            public static com.liferay.portlet.journal.model.JournalStructure addStructure(
286                    long userId, long groupId, java.lang.String structureId,
287                    boolean autoStructureId, java.lang.String parentStructureId,
288                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
289                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
290                    java.lang.String xsd,
291                    com.liferay.portal.service.ServiceContext serviceContext)
292                    throws com.liferay.portal.kernel.exception.PortalException,
293                            com.liferay.portal.kernel.exception.SystemException {
294                    return getService()
295                                       .addStructure(userId, groupId, structureId, autoStructureId,
296                            parentStructureId, nameMap, descriptionMap, xsd, serviceContext);
297            }
298    
299            public static void addStructureResources(
300                    com.liferay.portlet.journal.model.JournalStructure structure,
301                    boolean addGroupPermissions, boolean addGuestPermissions)
302                    throws com.liferay.portal.kernel.exception.PortalException,
303                            com.liferay.portal.kernel.exception.SystemException {
304                    getService()
305                            .addStructureResources(structure, addGroupPermissions,
306                            addGuestPermissions);
307            }
308    
309            public static void addStructureResources(
310                    com.liferay.portlet.journal.model.JournalStructure structure,
311                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    getService()
315                            .addStructureResources(structure, groupPermissions, guestPermissions);
316            }
317    
318            public static void addStructureResources(long groupId,
319                    java.lang.String structureId, boolean addGroupPermissions,
320                    boolean addGuestPermissions)
321                    throws com.liferay.portal.kernel.exception.PortalException,
322                            com.liferay.portal.kernel.exception.SystemException {
323                    getService()
324                            .addStructureResources(groupId, structureId, addGroupPermissions,
325                            addGuestPermissions);
326            }
327    
328            public static void addStructureResources(long groupId,
329                    java.lang.String structureId, java.lang.String[] groupPermissions,
330                    java.lang.String[] guestPermissions)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException {
333                    getService()
334                            .addStructureResources(groupId, structureId, groupPermissions,
335                            guestPermissions);
336            }
337    
338            public static void checkNewLine(long groupId, java.lang.String structureId)
339                    throws com.liferay.portal.kernel.exception.PortalException,
340                            com.liferay.portal.kernel.exception.SystemException {
341                    getService().checkNewLine(groupId, structureId);
342            }
343    
344            public static com.liferay.portlet.journal.model.JournalStructure copyStructure(
345                    long userId, long groupId, java.lang.String oldStructureId,
346                    java.lang.String newStructureId, boolean autoStructureId)
347                    throws com.liferay.portal.kernel.exception.PortalException,
348                            com.liferay.portal.kernel.exception.SystemException {
349                    return getService()
350                                       .copyStructure(userId, groupId, oldStructureId,
351                            newStructureId, autoStructureId);
352            }
353    
354            public static void deleteStructure(
355                    com.liferay.portlet.journal.model.JournalStructure structure)
356                    throws com.liferay.portal.kernel.exception.PortalException,
357                            com.liferay.portal.kernel.exception.SystemException {
358                    getService().deleteStructure(structure);
359            }
360    
361            public static void deleteStructure(long groupId,
362                    java.lang.String structureId)
363                    throws com.liferay.portal.kernel.exception.PortalException,
364                            com.liferay.portal.kernel.exception.SystemException {
365                    getService().deleteStructure(groupId, structureId);
366            }
367    
368            public static void deleteStructures(long groupId)
369                    throws com.liferay.portal.kernel.exception.PortalException,
370                            com.liferay.portal.kernel.exception.SystemException {
371                    getService().deleteStructures(groupId);
372            }
373    
374            public static com.liferay.portlet.journal.model.JournalStructure getStructure(
375                    long id)
376                    throws com.liferay.portal.kernel.exception.PortalException,
377                            com.liferay.portal.kernel.exception.SystemException {
378                    return getService().getStructure(id);
379            }
380    
381            public static com.liferay.portlet.journal.model.JournalStructure getStructure(
382                    long groupId, java.lang.String structureId)
383                    throws com.liferay.portal.kernel.exception.PortalException,
384                            com.liferay.portal.kernel.exception.SystemException {
385                    return getService().getStructure(groupId, structureId);
386            }
387    
388            public static com.liferay.portlet.journal.model.JournalStructure getStructure(
389                    long groupId, java.lang.String structureId,
390                    boolean includeGlobalStructures)
391                    throws com.liferay.portal.kernel.exception.PortalException,
392                            com.liferay.portal.kernel.exception.SystemException {
393                    return getService()
394                                       .getStructure(groupId, structureId, includeGlobalStructures);
395            }
396    
397            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures()
398                    throws com.liferay.portal.kernel.exception.SystemException {
399                    return getService().getStructures();
400            }
401    
402            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
403                    long groupId)
404                    throws com.liferay.portal.kernel.exception.SystemException {
405                    return getService().getStructures(groupId);
406            }
407    
408            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
409                    long groupId, int start, int end)
410                    throws com.liferay.portal.kernel.exception.SystemException {
411                    return getService().getStructures(groupId, start, end);
412            }
413    
414            public static int getStructuresCount(long groupId)
415                    throws com.liferay.portal.kernel.exception.SystemException {
416                    return getService().getStructuresCount(groupId);
417            }
418    
419            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
420                    long companyId, long[] groupIds, java.lang.String keywords, int start,
421                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
422                    throws com.liferay.portal.kernel.exception.SystemException {
423                    return getService()
424                                       .search(companyId, groupIds, keywords, start, end, obc);
425            }
426    
427            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
428                    long companyId, long[] groupIds, java.lang.String structureId,
429                    java.lang.String name, java.lang.String description,
430                    boolean andOperator, int start, int end,
431                    com.liferay.portal.kernel.util.OrderByComparator obc)
432                    throws com.liferay.portal.kernel.exception.SystemException {
433                    return getService()
434                                       .search(companyId, groupIds, structureId, name, description,
435                            andOperator, start, end, obc);
436            }
437    
438            public static int searchCount(long companyId, long[] groupIds,
439                    java.lang.String keywords)
440                    throws com.liferay.portal.kernel.exception.SystemException {
441                    return getService().searchCount(companyId, groupIds, keywords);
442            }
443    
444            public static int searchCount(long companyId, long[] groupIds,
445                    java.lang.String structureId, java.lang.String name,
446                    java.lang.String description, boolean andOperator)
447                    throws com.liferay.portal.kernel.exception.SystemException {
448                    return getService()
449                                       .searchCount(companyId, groupIds, structureId, name,
450                            description, andOperator);
451            }
452    
453            public static com.liferay.portlet.journal.model.JournalStructure updateStructure(
454                    long groupId, java.lang.String structureId,
455                    java.lang.String parentStructureId,
456                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
457                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
458                    java.lang.String xsd,
459                    com.liferay.portal.service.ServiceContext serviceContext)
460                    throws com.liferay.portal.kernel.exception.PortalException,
461                            com.liferay.portal.kernel.exception.SystemException {
462                    return getService()
463                                       .updateStructure(groupId, structureId, parentStructureId,
464                            nameMap, descriptionMap, xsd, serviceContext);
465            }
466    
467            public static JournalStructureLocalService getService() {
468                    if (_service == null) {
469                            _service = (JournalStructureLocalService)PortalBeanLocatorUtil.locate(JournalStructureLocalService.class.getName());
470    
471                            ReferenceRegistry.registerReference(JournalStructureLocalServiceUtil.class,
472                                    "_service");
473                    }
474    
475                    return _service;
476            }
477    
478            /**
479             * @deprecated
480             */
481            public void setService(JournalStructureLocalService service) {
482            }
483    
484            private static JournalStructureLocalService _service;
485    }