001    /**
002     * Copyright (c) 2000-present 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.portal.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.security.access.control.AccessControlled;
023    import com.liferay.portal.kernel.transaction.Isolation;
024    import com.liferay.portal.kernel.transaction.Transactional;
025    import com.liferay.portal.model.Layout;
026    import com.liferay.portal.model.PortletItem;
027    import com.liferay.portal.model.PortletPreferences;
028    
029    /**
030     * Provides the remote service interface for PortletPreferences. Methods of this
031     * service are expected to have security checks based on the propagated JAAS
032     * credentials because this service can be accessed remotely.
033     *
034     * @author Brian Wing Shun Chan
035     * @see PortletPreferencesServiceUtil
036     * @see com.liferay.portal.service.base.PortletPreferencesServiceBaseImpl
037     * @see com.liferay.portal.service.impl.PortletPreferencesServiceImpl
038     * @generated
039     */
040    @AccessControlled
041    @JSONWebService
042    @ProviderType
043    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
044            PortalException.class, SystemException.class})
045    public interface PortletPreferencesService extends BaseService {
046            /*
047             * NOTE FOR DEVELOPERS:
048             *
049             * Never modify or reference this interface directly. Always use {@link PortletPreferencesServiceUtil} to access the portlet preferences remote service. Add custom service methods to {@link com.liferay.portal.service.impl.PortletPreferencesServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
050             */
051            public void deleteArchivedPreferences(long portletItemId)
052                    throws PortalException;
053    
054            /**
055            * Returns the OSGi service identifier.
056            *
057            * @return the OSGi service identifier
058            */
059            public java.lang.String getOSGiServiceIdentifier();
060    
061            public void restoreArchivedPreferences(long groupId, Layout layout,
062                    java.lang.String portletId, PortletItem portletItem,
063                    javax.portlet.PortletPreferences preferences) throws PortalException;
064    
065            public void restoreArchivedPreferences(long groupId, Layout layout,
066                    java.lang.String portletId, long portletItemId,
067                    javax.portlet.PortletPreferences preferences) throws PortalException;
068    
069            public void restoreArchivedPreferences(long groupId, java.lang.String name,
070                    Layout layout, java.lang.String portletId,
071                    javax.portlet.PortletPreferences preferences) throws PortalException;
072    
073            public void updateArchivePreferences(long userId, long groupId,
074                    java.lang.String name, java.lang.String portletId,
075                    javax.portlet.PortletPreferences preferences) throws PortalException;
076    }