001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * 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.
023     *
024     * <p>
025     * 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.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see JournalStructureLocalService
030     * @see com.liferay.portlet.journal.service.base.JournalStructureLocalServiceBaseImpl
031     * @see com.liferay.portlet.journal.service.impl.JournalStructureLocalServiceImpl
032     * @generated
033     */
034    public class JournalStructureLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * 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.
039             */
040    
041            /**
042            * Adds the journal structure to the database. Also notifies the appropriate model listeners.
043            *
044            * @param journalStructure the journal structure
045            * @return the journal structure that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.journal.model.JournalStructure addJournalStructure(
049                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addJournalStructure(journalStructure);
052            }
053    
054            /**
055            * Creates a new journal structure with the primary key. Does not add the journal structure to the database.
056            *
057            * @param id the primary key for the new journal structure
058            * @return the new journal structure
059            */
060            public static com.liferay.portlet.journal.model.JournalStructure createJournalStructure(
061                    long id) {
062                    return getService().createJournalStructure(id);
063            }
064    
065            /**
066            * Deletes the journal structure with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param id the primary key of the journal structure
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 void deleteJournalStructure(long id)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteJournalStructure(id);
076            }
077    
078            /**
079            * Deletes the journal structure from the database. Also notifies the appropriate model listeners.
080            *
081            * @param journalStructure the journal structure
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteJournalStructure(
085                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteJournalStructure(journalStructure);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * 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.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * 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.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            /**
162            * Returns the journal structure with the primary key.
163            *
164            * @param id the primary key of the journal structure
165            * @return the journal structure
166            * @throws PortalException if a journal structure with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portlet.journal.model.JournalStructure getJournalStructure(
170                    long id)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getJournalStructure(id);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns the journal structure with the UUID in the group.
185            *
186            * @param uuid the UUID of journal structure
187            * @param groupId the group id of the journal structure
188            * @return the journal structure
189            * @throws PortalException if a journal structure with the UUID in the group could not be found
190            * @throws SystemException if a system exception occurred
191            */
192            public static com.liferay.portlet.journal.model.JournalStructure getJournalStructureByUuidAndGroupId(
193                    java.lang.String uuid, long groupId)
194                    throws com.liferay.portal.kernel.exception.PortalException,
195                            com.liferay.portal.kernel.exception.SystemException {
196                    return getService().getJournalStructureByUuidAndGroupId(uuid, groupId);
197            }
198    
199            /**
200            * Returns a range of all the journal structures.
201            *
202            * <p>
203            * 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.
204            * </p>
205            *
206            * @param start the lower bound of the range of journal structures
207            * @param end the upper bound of the range of journal structures (not inclusive)
208            * @return the range of journal structures
209            * @throws SystemException if a system exception occurred
210            */
211            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getJournalStructures(
212                    int start, int end)
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getJournalStructures(start, end);
215            }
216    
217            /**
218            * Returns the number of journal structures.
219            *
220            * @return the number of journal structures
221            * @throws SystemException if a system exception occurred
222            */
223            public static int getJournalStructuresCount()
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getJournalStructuresCount();
226            }
227    
228            /**
229            * Updates the journal structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
230            *
231            * @param journalStructure the journal structure
232            * @return the journal structure that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public static com.liferay.portlet.journal.model.JournalStructure updateJournalStructure(
236                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
237                    throws com.liferay.portal.kernel.exception.SystemException {
238                    return getService().updateJournalStructure(journalStructure);
239            }
240    
241            /**
242            * Updates the journal structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
243            *
244            * @param journalStructure the journal structure
245            * @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.
246            * @return the journal structure that was updated
247            * @throws SystemException if a system exception occurred
248            */
249            public static com.liferay.portlet.journal.model.JournalStructure updateJournalStructure(
250                    com.liferay.portlet.journal.model.JournalStructure journalStructure,
251                    boolean merge)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateJournalStructure(journalStructure, merge);
254            }
255    
256            /**
257            * Returns the Spring bean ID for this bean.
258            *
259            * @return the Spring bean ID for this bean
260            */
261            public static java.lang.String getBeanIdentifier() {
262                    return getService().getBeanIdentifier();
263            }
264    
265            /**
266            * Sets the Spring bean ID for this bean.
267            *
268            * @param beanIdentifier the Spring bean ID for this bean
269            */
270            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
271                    getService().setBeanIdentifier(beanIdentifier);
272            }
273    
274            public static com.liferay.portlet.journal.model.JournalStructure addStructure(
275                    long userId, long groupId, java.lang.String structureId,
276                    boolean autoStructureId, java.lang.String parentStructureId,
277                    java.lang.String name, java.lang.String description,
278                    java.lang.String xsd,
279                    com.liferay.portal.service.ServiceContext serviceContext)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException {
282                    return getService()
283                                       .addStructure(userId, groupId, structureId, autoStructureId,
284                            parentStructureId, name, description, xsd, serviceContext);
285            }
286    
287            public static void addStructureResources(
288                    com.liferay.portlet.journal.model.JournalStructure structure,
289                    boolean addCommunityPermissions, boolean addGuestPermissions)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    getService()
293                            .addStructureResources(structure, addCommunityPermissions,
294                            addGuestPermissions);
295            }
296    
297            public static void addStructureResources(
298                    com.liferay.portlet.journal.model.JournalStructure structure,
299                    java.lang.String[] communityPermissions,
300                    java.lang.String[] guestPermissions)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException {
303                    getService()
304                            .addStructureResources(structure, communityPermissions,
305                            guestPermissions);
306            }
307    
308            public static void addStructureResources(long groupId,
309                    java.lang.String structureId, boolean addCommunityPermissions,
310                    boolean addGuestPermissions)
311                    throws com.liferay.portal.kernel.exception.PortalException,
312                            com.liferay.portal.kernel.exception.SystemException {
313                    getService()
314                            .addStructureResources(groupId, structureId,
315                            addCommunityPermissions, addGuestPermissions);
316            }
317    
318            public static void addStructureResources(long groupId,
319                    java.lang.String structureId, java.lang.String[] communityPermissions,
320                    java.lang.String[] guestPermissions)
321                    throws com.liferay.portal.kernel.exception.PortalException,
322                            com.liferay.portal.kernel.exception.SystemException {
323                    getService()
324                            .addStructureResources(groupId, structureId, communityPermissions,
325                            guestPermissions);
326            }
327    
328            public static void checkNewLine(long groupId, java.lang.String structureId)
329                    throws com.liferay.portal.kernel.exception.PortalException,
330                            com.liferay.portal.kernel.exception.SystemException {
331                    getService().checkNewLine(groupId, structureId);
332            }
333    
334            public static com.liferay.portlet.journal.model.JournalStructure copyStructure(
335                    long userId, long groupId, java.lang.String oldStructureId,
336                    java.lang.String newStructureId, boolean autoStructureId)
337                    throws com.liferay.portal.kernel.exception.PortalException,
338                            com.liferay.portal.kernel.exception.SystemException {
339                    return getService()
340                                       .copyStructure(userId, groupId, oldStructureId,
341                            newStructureId, autoStructureId);
342            }
343    
344            public static void deleteStructure(
345                    com.liferay.portlet.journal.model.JournalStructure structure)
346                    throws com.liferay.portal.kernel.exception.PortalException,
347                            com.liferay.portal.kernel.exception.SystemException {
348                    getService().deleteStructure(structure);
349            }
350    
351            public static void deleteStructure(long groupId,
352                    java.lang.String structureId)
353                    throws com.liferay.portal.kernel.exception.PortalException,
354                            com.liferay.portal.kernel.exception.SystemException {
355                    getService().deleteStructure(groupId, structureId);
356            }
357    
358            public static void deleteStructures(long groupId)
359                    throws com.liferay.portal.kernel.exception.PortalException,
360                            com.liferay.portal.kernel.exception.SystemException {
361                    getService().deleteStructures(groupId);
362            }
363    
364            public static com.liferay.portlet.journal.model.JournalStructure getStructure(
365                    long id)
366                    throws com.liferay.portal.kernel.exception.PortalException,
367                            com.liferay.portal.kernel.exception.SystemException {
368                    return getService().getStructure(id);
369            }
370    
371            public static com.liferay.portlet.journal.model.JournalStructure getStructure(
372                    long groupId, java.lang.String structureId)
373                    throws com.liferay.portal.kernel.exception.PortalException,
374                            com.liferay.portal.kernel.exception.SystemException {
375                    return getService().getStructure(groupId, structureId);
376            }
377    
378            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures()
379                    throws com.liferay.portal.kernel.exception.SystemException {
380                    return getService().getStructures();
381            }
382    
383            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
384                    long groupId)
385                    throws com.liferay.portal.kernel.exception.SystemException {
386                    return getService().getStructures(groupId);
387            }
388    
389            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
390                    long groupId, int start, int end)
391                    throws com.liferay.portal.kernel.exception.SystemException {
392                    return getService().getStructures(groupId, start, end);
393            }
394    
395            public static int getStructuresCount(long groupId)
396                    throws com.liferay.portal.kernel.exception.SystemException {
397                    return getService().getStructuresCount(groupId);
398            }
399    
400            /**
401            * @deprecated {@link #search(long, long[], String, int, int,
402            OrderByComparator)}
403            */
404            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
405                    long companyId, long groupId, java.lang.String keywords, int start,
406                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
407                    throws com.liferay.portal.kernel.exception.SystemException {
408                    return getService().search(companyId, groupId, keywords, start, end, obc);
409            }
410    
411            /**
412            * @deprecated {@link #search(long, long[], String, String, String, boolean,
413            int, int, OrderByComparator)}
414            */
415            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
416                    long companyId, long groupId, java.lang.String structureId,
417                    java.lang.String name, java.lang.String description,
418                    boolean andOperator, int start, int end,
419                    com.liferay.portal.kernel.util.OrderByComparator obc)
420                    throws com.liferay.portal.kernel.exception.SystemException {
421                    return getService()
422                                       .search(companyId, groupId, structureId, name, description,
423                            andOperator, start, end, obc);
424            }
425    
426            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
427                    long companyId, long[] groupIds, java.lang.String keywords, int start,
428                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
429                    throws com.liferay.portal.kernel.exception.SystemException {
430                    return getService()
431                                       .search(companyId, groupIds, keywords, start, end, obc);
432            }
433    
434            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
435                    long companyId, long[] groupIds, java.lang.String structureId,
436                    java.lang.String name, java.lang.String description,
437                    boolean andOperator, int start, int end,
438                    com.liferay.portal.kernel.util.OrderByComparator obc)
439                    throws com.liferay.portal.kernel.exception.SystemException {
440                    return getService()
441                                       .search(companyId, groupIds, structureId, name, description,
442                            andOperator, start, end, obc);
443            }
444    
445            /**
446            * @deprecated {@link #searchCount(long, long[], String)}
447            */
448            public static int searchCount(long companyId, long groupId,
449                    java.lang.String keywords)
450                    throws com.liferay.portal.kernel.exception.SystemException {
451                    return getService().searchCount(companyId, groupId, keywords);
452            }
453    
454            /**
455            * @deprecated {@link #searchCount(long, long[], String, String, String,
456            boolean)}
457            */
458            public static int searchCount(long companyId, long groupId,
459                    java.lang.String structureId, java.lang.String name,
460                    java.lang.String description, boolean andOperator)
461                    throws com.liferay.portal.kernel.exception.SystemException {
462                    return getService()
463                                       .searchCount(companyId, groupId, structureId, name,
464                            description, andOperator);
465            }
466    
467            public static int searchCount(long companyId, long[] groupIds,
468                    java.lang.String keywords)
469                    throws com.liferay.portal.kernel.exception.SystemException {
470                    return getService().searchCount(companyId, groupIds, keywords);
471            }
472    
473            public static int searchCount(long companyId, long[] groupIds,
474                    java.lang.String structureId, java.lang.String name,
475                    java.lang.String description, boolean andOperator)
476                    throws com.liferay.portal.kernel.exception.SystemException {
477                    return getService()
478                                       .searchCount(companyId, groupIds, structureId, name,
479                            description, andOperator);
480            }
481    
482            public static com.liferay.portlet.journal.model.JournalStructure updateStructure(
483                    long groupId, java.lang.String structureId,
484                    java.lang.String parentStructureId, java.lang.String name,
485                    java.lang.String description, java.lang.String xsd,
486                    com.liferay.portal.service.ServiceContext serviceContext)
487                    throws com.liferay.portal.kernel.exception.PortalException,
488                            com.liferay.portal.kernel.exception.SystemException {
489                    return getService()
490                                       .updateStructure(groupId, structureId, parentStructureId,
491                            name, description, xsd, serviceContext);
492            }
493    
494            public static JournalStructureLocalService getService() {
495                    if (_service == null) {
496                            _service = (JournalStructureLocalService)PortalBeanLocatorUtil.locate(JournalStructureLocalService.class.getName());
497    
498                            ReferenceRegistry.registerReference(JournalStructureLocalServiceUtil.class,
499                                    "_service");
500                            MethodCache.remove(JournalStructureLocalService.class);
501                    }
502    
503                    return _service;
504            }
505    
506            public void setService(JournalStructureLocalService service) {
507                    MethodCache.remove(JournalStructureLocalService.class);
508    
509                    _service = service;
510    
511                    ReferenceRegistry.registerReference(JournalStructureLocalServiceUtil.class,
512                            "_service");
513                    MethodCache.remove(JournalStructureLocalService.class);
514            }
515    
516            private static JournalStructureLocalService _service;
517    }