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.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.jsonwebservice.JSONWebService;
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.security.ac.AccessControlled;
026    import com.liferay.portal.service.BaseService;
027    
028    /**
029     * Provides the remote service interface for JournalStructure. Methods of this
030     * service are expected to have security checks based on the propagated JAAS
031     * credentials because this service can be accessed remotely.
032     *
033     * @author Brian Wing Shun Chan
034     * @see JournalStructureServiceUtil
035     * @see com.liferay.portlet.journal.service.base.JournalStructureServiceBaseImpl
036     * @see com.liferay.portlet.journal.service.impl.JournalStructureServiceImpl
037     * @deprecated As of 6.2.0, since Web Content Administration now uses the
038                Dynamic Data Mapping framework to handle templates
039     * @generated
040     */
041    @ProviderType
042    @AccessControlled
043    @JSONWebService
044    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
045            PortalException.class, SystemException.class})
046    public interface JournalStructureService extends BaseService {
047            /*
048             * NOTE FOR DEVELOPERS:
049             *
050             * Never modify or reference this interface directly. Always use {@link JournalStructureServiceUtil} to access the journal structure remote service. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalStructureServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
051             */
052    
053            /**
054            * Returns the Spring bean ID for this bean.
055            *
056            * @return the Spring bean ID for this bean
057            */
058            public java.lang.String getBeanIdentifier();
059    
060            /**
061            * Sets the Spring bean ID for this bean.
062            *
063            * @param beanIdentifier the Spring bean ID for this bean
064            */
065            public void setBeanIdentifier(java.lang.String beanIdentifier);
066    
067            public com.liferay.portlet.journal.model.JournalStructure addStructure(
068                    long groupId, java.lang.String structureId, boolean autoStructureId,
069                    java.lang.String parentStructureId,
070                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
071                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
072                    java.lang.String xsd,
073                    com.liferay.portal.service.ServiceContext serviceContext)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            public com.liferay.portlet.journal.model.JournalStructure copyStructure(
078                    long groupId, java.lang.String oldStructureId,
079                    java.lang.String newStructureId, boolean autoStructureId)
080                    throws com.liferay.portal.kernel.exception.PortalException,
081                            com.liferay.portal.kernel.exception.SystemException;
082    
083            public void deleteStructure(long groupId, java.lang.String structureId)
084                    throws com.liferay.portal.kernel.exception.PortalException,
085                            com.liferay.portal.kernel.exception.SystemException;
086    
087            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
088            public com.liferay.portlet.journal.model.JournalStructure getStructure(
089                    long groupId, java.lang.String structureId)
090                    throws com.liferay.portal.kernel.exception.PortalException,
091                            com.liferay.portal.kernel.exception.SystemException;
092    
093            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
094            public com.liferay.portlet.journal.model.JournalStructure getStructure(
095                    long groupId, java.lang.String structureId,
096                    boolean includeGlobalStructures)
097                    throws com.liferay.portal.kernel.exception.PortalException,
098                            com.liferay.portal.kernel.exception.SystemException;
099    
100            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
101            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
102                    long groupId)
103                    throws com.liferay.portal.kernel.exception.SystemException;
104    
105            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
106            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
107                    long[] groupIds)
108                    throws com.liferay.portal.kernel.exception.SystemException;
109    
110            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
111            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
112                    long companyId, long[] groupIds, java.lang.String keywords, int start,
113                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
114                    throws com.liferay.portal.kernel.exception.SystemException;
115    
116            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
117            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
118                    long companyId, long[] groupIds, java.lang.String structureId,
119                    java.lang.String name, java.lang.String description,
120                    boolean andOperator, int start, int end,
121                    com.liferay.portal.kernel.util.OrderByComparator obc)
122                    throws com.liferay.portal.kernel.exception.SystemException;
123    
124            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
125            public int searchCount(long companyId, long[] groupIds,
126                    java.lang.String keywords)
127                    throws com.liferay.portal.kernel.exception.SystemException;
128    
129            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
130            public int searchCount(long companyId, long[] groupIds,
131                    java.lang.String structureId, java.lang.String name,
132                    java.lang.String description, boolean andOperator)
133                    throws com.liferay.portal.kernel.exception.SystemException;
134    
135            public com.liferay.portlet.journal.model.JournalStructure updateStructure(
136                    long groupId, java.lang.String structureId,
137                    java.lang.String parentStructureId,
138                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
139                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
140                    java.lang.String xsd,
141                    com.liferay.portal.service.ServiceContext serviceContext)
142                    throws com.liferay.portal.kernel.exception.PortalException,
143                            com.liferay.portal.kernel.exception.SystemException;
144    }