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.service.BaseService;
024    
025    /**
026     * The interface for the journal structure remote service.
027     *
028     * <p>
029     * 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.
030     * </p>
031     *
032     * @author Brian Wing Shun Chan
033     * @see JournalStructureServiceUtil
034     * @see com.liferay.portlet.journal.service.base.JournalStructureServiceBaseImpl
035     * @see com.liferay.portlet.journal.service.impl.JournalStructureServiceImpl
036     * @generated
037     */
038    @JSONWebService
039    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
040            PortalException.class, SystemException.class})
041    public interface JournalStructureService extends BaseService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * 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.
046             */
047    
048            /**
049            * Returns the Spring bean ID for this bean.
050            *
051            * @return the Spring bean ID for this bean
052            */
053            public java.lang.String getBeanIdentifier();
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 void setBeanIdentifier(java.lang.String beanIdentifier);
061    
062            public com.liferay.portlet.journal.model.JournalStructure addStructure(
063                    long groupId, java.lang.String structureId, boolean autoStructureId,
064                    java.lang.String parentStructureId,
065                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
066                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
067                    java.lang.String xsd,
068                    com.liferay.portal.service.ServiceContext serviceContext)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException;
071    
072            public com.liferay.portlet.journal.model.JournalStructure copyStructure(
073                    long groupId, java.lang.String oldStructureId,
074                    java.lang.String newStructureId, boolean autoStructureId)
075                    throws com.liferay.portal.kernel.exception.PortalException,
076                            com.liferay.portal.kernel.exception.SystemException;
077    
078            public void deleteStructure(long groupId, java.lang.String structureId)
079                    throws com.liferay.portal.kernel.exception.PortalException,
080                            com.liferay.portal.kernel.exception.SystemException;
081    
082            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
083            public com.liferay.portlet.journal.model.JournalStructure getStructure(
084                    long groupId, java.lang.String structureId)
085                    throws com.liferay.portal.kernel.exception.PortalException,
086                            com.liferay.portal.kernel.exception.SystemException;
087    
088            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
089            public com.liferay.portlet.journal.model.JournalStructure getStructure(
090                    long groupId, java.lang.String structureId,
091                    boolean includeGlobalStructures)
092                    throws com.liferay.portal.kernel.exception.PortalException,
093                            com.liferay.portal.kernel.exception.SystemException;
094    
095            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
096            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
097                    long groupId)
098                    throws 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> search(
102                    long companyId, long[] groupIds, java.lang.String keywords, int start,
103                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
104                    throws com.liferay.portal.kernel.exception.SystemException;
105    
106            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
107            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
108                    long companyId, long[] groupIds, java.lang.String structureId,
109                    java.lang.String name, java.lang.String description,
110                    boolean andOperator, int start, int end,
111                    com.liferay.portal.kernel.util.OrderByComparator obc)
112                    throws com.liferay.portal.kernel.exception.SystemException;
113    
114            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
115            public int searchCount(long companyId, long[] groupIds,
116                    java.lang.String keywords)
117                    throws com.liferay.portal.kernel.exception.SystemException;
118    
119            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
120            public int searchCount(long companyId, long[] groupIds,
121                    java.lang.String structureId, java.lang.String name,
122                    java.lang.String description, boolean andOperator)
123                    throws com.liferay.portal.kernel.exception.SystemException;
124    
125            public com.liferay.portlet.journal.model.JournalStructure updateStructure(
126                    long groupId, java.lang.String structureId,
127                    java.lang.String parentStructureId,
128                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
129                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
130                    java.lang.String xsd,
131                    com.liferay.portal.service.ServiceContext serviceContext)
132                    throws com.liferay.portal.kernel.exception.PortalException,
133                            com.liferay.portal.kernel.exception.SystemException;
134    }