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 aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
020    import com.liferay.portal.kernel.util.ReferenceRegistry;
021    
022    /**
023     * Provides the remote service utility for JournalStructure. This utility wraps
024     * {@link com.liferay.portlet.journal.service.impl.JournalStructureServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on a remote server. Methods of this service are expected to have security
027     * checks based on the propagated JAAS credentials because this service can be
028     * accessed remotely.
029     *
030     * @author Brian Wing Shun Chan
031     * @see JournalStructureService
032     * @see com.liferay.portlet.journal.service.base.JournalStructureServiceBaseImpl
033     * @see com.liferay.portlet.journal.service.impl.JournalStructureServiceImpl
034     * @deprecated As of 6.2.0, since Web Content Administration now uses the
035    Dynamic Data Mapping framework to handle templates
036     * @generated
037     */
038    @ProviderType
039    public class JournalStructureServiceUtil {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalStructureServiceImpl} and rerun ServiceBuilder to regenerate this class.
044             */
045    
046            /**
047            * Returns the Spring bean ID for this bean.
048            *
049            * @return the Spring bean ID for this bean
050            */
051            public static java.lang.String getBeanIdentifier() {
052                    return getService().getBeanIdentifier();
053            }
054    
055            /**
056            * Sets the Spring bean ID for this bean.
057            *
058            * @param beanIdentifier the Spring bean ID for this bean
059            */
060            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
061                    getService().setBeanIdentifier(beanIdentifier);
062            }
063    
064            public static com.liferay.portlet.journal.model.JournalStructure addStructure(
065                    long groupId, java.lang.String structureId, boolean autoStructureId,
066                    java.lang.String parentStructureId,
067                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
068                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
069                    java.lang.String xsd,
070                    com.liferay.portal.service.ServiceContext serviceContext)
071                    throws com.liferay.portal.kernel.exception.PortalException,
072                            com.liferay.portal.kernel.exception.SystemException {
073                    return getService()
074                                       .addStructure(groupId, structureId, autoStructureId,
075                            parentStructureId, nameMap, descriptionMap, xsd, serviceContext);
076            }
077    
078            public static com.liferay.portlet.journal.model.JournalStructure copyStructure(
079                    long groupId, java.lang.String oldStructureId,
080                    java.lang.String newStructureId, boolean autoStructureId)
081                    throws com.liferay.portal.kernel.exception.PortalException,
082                            com.liferay.portal.kernel.exception.SystemException {
083                    return getService()
084                                       .copyStructure(groupId, oldStructureId, newStructureId,
085                            autoStructureId);
086            }
087    
088            public static void deleteStructure(long groupId,
089                    java.lang.String structureId)
090                    throws com.liferay.portal.kernel.exception.PortalException,
091                            com.liferay.portal.kernel.exception.SystemException {
092                    getService().deleteStructure(groupId, structureId);
093            }
094    
095            public static com.liferay.portlet.journal.model.JournalStructure getStructure(
096                    long groupId, java.lang.String structureId)
097                    throws com.liferay.portal.kernel.exception.PortalException,
098                            com.liferay.portal.kernel.exception.SystemException {
099                    return getService().getStructure(groupId, structureId);
100            }
101    
102            public static com.liferay.portlet.journal.model.JournalStructure getStructure(
103                    long groupId, java.lang.String structureId,
104                    boolean includeGlobalStructures)
105                    throws com.liferay.portal.kernel.exception.PortalException,
106                            com.liferay.portal.kernel.exception.SystemException {
107                    return getService()
108                                       .getStructure(groupId, structureId, includeGlobalStructures);
109            }
110    
111            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
112                    long groupId)
113                    throws com.liferay.portal.kernel.exception.SystemException {
114                    return getService().getStructures(groupId);
115            }
116    
117            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
118                    long[] groupIds)
119                    throws com.liferay.portal.kernel.exception.SystemException {
120                    return getService().getStructures(groupIds);
121            }
122    
123            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
124                    long companyId, long[] groupIds, java.lang.String keywords, int start,
125                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
126                    throws com.liferay.portal.kernel.exception.SystemException {
127                    return getService()
128                                       .search(companyId, groupIds, keywords, start, end, obc);
129            }
130    
131            public static java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
132                    long companyId, long[] groupIds, java.lang.String structureId,
133                    java.lang.String name, java.lang.String description,
134                    boolean andOperator, int start, int end,
135                    com.liferay.portal.kernel.util.OrderByComparator obc)
136                    throws com.liferay.portal.kernel.exception.SystemException {
137                    return getService()
138                                       .search(companyId, groupIds, structureId, name, description,
139                            andOperator, start, end, obc);
140            }
141    
142            public static int searchCount(long companyId, long[] groupIds,
143                    java.lang.String keywords)
144                    throws com.liferay.portal.kernel.exception.SystemException {
145                    return getService().searchCount(companyId, groupIds, keywords);
146            }
147    
148            public static int searchCount(long companyId, long[] groupIds,
149                    java.lang.String structureId, java.lang.String name,
150                    java.lang.String description, boolean andOperator)
151                    throws com.liferay.portal.kernel.exception.SystemException {
152                    return getService()
153                                       .searchCount(companyId, groupIds, structureId, name,
154                            description, andOperator);
155            }
156    
157            public static com.liferay.portlet.journal.model.JournalStructure updateStructure(
158                    long groupId, java.lang.String structureId,
159                    java.lang.String parentStructureId,
160                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
161                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
162                    java.lang.String xsd,
163                    com.liferay.portal.service.ServiceContext serviceContext)
164                    throws com.liferay.portal.kernel.exception.PortalException,
165                            com.liferay.portal.kernel.exception.SystemException {
166                    return getService()
167                                       .updateStructure(groupId, structureId, parentStructureId,
168                            nameMap, descriptionMap, xsd, serviceContext);
169            }
170    
171            public static JournalStructureService getService() {
172                    if (_service == null) {
173                            _service = (JournalStructureService)PortalBeanLocatorUtil.locate(JournalStructureService.class.getName());
174    
175                            ReferenceRegistry.registerReference(JournalStructureServiceUtil.class,
176                                    "_service");
177                    }
178    
179                    return _service;
180            }
181    
182            /**
183             * @deprecated As of 6.2.0
184             */
185            public void setService(JournalStructureService service) {
186            }
187    
188            private static JournalStructureService _service;
189    }