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.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.jsonwebservice.JSONWebService;
020    import com.liferay.portal.kernel.transaction.Isolation;
021    import com.liferay.portal.kernel.transaction.Propagation;
022    import com.liferay.portal.kernel.transaction.Transactional;
023    import com.liferay.portal.security.ac.AccessControlled;
024    import com.liferay.portal.service.BaseService;
025    
026    /**
027     * The interface for the journal structure remote service.
028     *
029     * <p>
030     * This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
031     * </p>
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     * @generated
038     */
039    @AccessControlled
040    @JSONWebService
041    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface JournalStructureService extends BaseService {
044            /*
045             * NOTE FOR DEVELOPERS:
046             *
047             * 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.
048             */
049    
050            /**
051            * Returns the Spring bean ID for this bean.
052            *
053            * @return the Spring bean ID for this bean
054            */
055            public java.lang.String getBeanIdentifier();
056    
057            /**
058            * Sets the Spring bean ID for this bean.
059            *
060            * @param beanIdentifier the Spring bean ID for this bean
061            */
062            public void setBeanIdentifier(java.lang.String beanIdentifier);
063    
064            public 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    
074            public com.liferay.portlet.journal.model.JournalStructure copyStructure(
075                    long groupId, java.lang.String oldStructureId,
076                    java.lang.String newStructureId, boolean autoStructureId)
077                    throws com.liferay.portal.kernel.exception.PortalException,
078                            com.liferay.portal.kernel.exception.SystemException;
079    
080            public void deleteStructure(long groupId, java.lang.String structureId)
081                    throws com.liferay.portal.kernel.exception.PortalException,
082                            com.liferay.portal.kernel.exception.SystemException;
083    
084            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
085            public com.liferay.portlet.journal.model.JournalStructure getStructure(
086                    long groupId, java.lang.String structureId)
087                    throws com.liferay.portal.kernel.exception.PortalException,
088                            com.liferay.portal.kernel.exception.SystemException;
089    
090            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
091            public com.liferay.portlet.journal.model.JournalStructure getStructure(
092                    long groupId, java.lang.String structureId,
093                    boolean includeGlobalStructures)
094                    throws com.liferay.portal.kernel.exception.PortalException,
095                            com.liferay.portal.kernel.exception.SystemException;
096    
097            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
098            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
099                    long groupId)
100                    throws com.liferay.portal.kernel.exception.SystemException;
101    
102            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
103            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
104                    long[] groupIds)
105                    throws com.liferay.portal.kernel.exception.SystemException;
106    
107            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
108            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
109                    long companyId, long[] groupIds, java.lang.String keywords, int start,
110                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
111                    throws com.liferay.portal.kernel.exception.SystemException;
112    
113            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
114            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
115                    long companyId, long[] groupIds, java.lang.String structureId,
116                    java.lang.String name, java.lang.String description,
117                    boolean andOperator, int start, int end,
118                    com.liferay.portal.kernel.util.OrderByComparator obc)
119                    throws com.liferay.portal.kernel.exception.SystemException;
120    
121            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
122            public int searchCount(long companyId, long[] groupIds,
123                    java.lang.String keywords)
124                    throws com.liferay.portal.kernel.exception.SystemException;
125    
126            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
127            public int searchCount(long companyId, long[] groupIds,
128                    java.lang.String structureId, java.lang.String name,
129                    java.lang.String description, boolean andOperator)
130                    throws com.liferay.portal.kernel.exception.SystemException;
131    
132            public com.liferay.portlet.journal.model.JournalStructure updateStructure(
133                    long groupId, java.lang.String structureId,
134                    java.lang.String parentStructureId,
135                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
136                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
137                    java.lang.String xsd,
138                    com.liferay.portal.service.ServiceContext serviceContext)
139                    throws com.liferay.portal.kernel.exception.PortalException,
140                            com.liferay.portal.kernel.exception.SystemException;
141    }