com.liferay.portal.service
Interface LayoutService


public interface LayoutService

View Source

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

This interface defines the service. The default implementation is com.liferay.portal.service.impl.LayoutServiceImpl. Modify methods in that class and rerun ServiceBuilder to populate this class and all other generated classes.

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.

Author:
Brian Wing Shun Chan
See Also:
LayoutServiceFactory, LayoutServiceUtil

Method Summary
 Layout addLayout(long groupId, boolean privateLayout, long parentLayoutId, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String type, boolean hidden, java.lang.String friendlyURL)
           
 void deleteLayout(long plid)
           
 void deleteLayout(long groupId, boolean privateLayout, long layoutId)
           
 byte[] exportLayouts(long groupId, boolean privateLayout, java.util.Map parameterMap)
           
 java.lang.String getLayoutName(long groupId, boolean privateLayout, long layoutId, java.lang.String languageId)
           
 LayoutReference[] getLayoutReferences(long companyId, java.lang.String portletId, java.lang.String prefsKey, java.lang.String prefsValue)
           
 void importLayouts(long groupId, boolean privateLayout, java.util.Map parameterMap, java.io.File file)
           
 void setLayouts(long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds)
           
 Layout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, java.lang.String name, java.lang.String title, java.lang.String languageId, java.lang.String description, java.lang.String type, boolean hidden, java.lang.String friendlyURL)
           
 Layout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, java.lang.String name, java.lang.String title, java.lang.String languageId, java.lang.String description, java.lang.String type, boolean hidden, java.lang.String friendlyURL, java.lang.Boolean iconImage, byte[] iconBytes)
           
 Layout updateLayout(long groupId, boolean privateLayout, long layoutId, java.lang.String typeSettings)
           
 Layout updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, java.lang.String themeId, java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
           
 Layout updateName(long groupId, boolean privateLayout, long layoutId, java.lang.String name, java.lang.String languageId)
           
 Layout updateName(long plid, java.lang.String name, java.lang.String languageId)
           
 Layout updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId)
           
 Layout updateParentLayoutId(long plid, long parentPlid)
           
 Layout updatePriority(long groupId, boolean privateLayout, long layoutId, int priority)
           
 Layout updatePriority(long plid, int priority)
           
 

Method Detail

addLayout

public Layout addLayout(long groupId,
                        boolean privateLayout,
                        long parentLayoutId,
                        java.lang.String name,
                        java.lang.String title,
                        java.lang.String description,
                        java.lang.String type,
                        boolean hidden,
                        java.lang.String friendlyURL)
                 throws com.liferay.portal.SystemException,
                        com.liferay.portal.PortalException,
                        java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

deleteLayout

public void deleteLayout(long plid)
                  throws com.liferay.portal.SystemException,
                         com.liferay.portal.PortalException,
                         java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

deleteLayout

public void deleteLayout(long groupId,
                         boolean privateLayout,
                         long layoutId)
                  throws com.liferay.portal.SystemException,
                         com.liferay.portal.PortalException,
                         java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getLayoutName

public java.lang.String getLayoutName(long groupId,
                                      boolean privateLayout,
                                      long layoutId,
                                      java.lang.String languageId)
                               throws com.liferay.portal.SystemException,
                                      com.liferay.portal.PortalException,
                                      java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getLayoutReferences

public LayoutReference[] getLayoutReferences(long companyId,
                                             java.lang.String portletId,
                                             java.lang.String prefsKey,
                                             java.lang.String prefsValue)
                                      throws com.liferay.portal.SystemException,
                                             java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
java.rmi.RemoteException

exportLayouts

public byte[] exportLayouts(long groupId,
                            boolean privateLayout,
                            java.util.Map parameterMap)
                     throws com.liferay.portal.SystemException,
                            com.liferay.portal.PortalException,
                            java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

importLayouts

public void importLayouts(long groupId,
                          boolean privateLayout,
                          java.util.Map parameterMap,
                          java.io.File file)
                   throws com.liferay.portal.SystemException,
                          com.liferay.portal.PortalException,
                          java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

setLayouts

public void setLayouts(long groupId,
                       boolean privateLayout,
                       long parentLayoutId,
                       long[] layoutIds)
                throws com.liferay.portal.SystemException,
                       com.liferay.portal.PortalException,
                       java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateLayout

public Layout updateLayout(long groupId,
                           boolean privateLayout,
                           long layoutId,
                           long parentLayoutId,
                           java.lang.String name,
                           java.lang.String title,
                           java.lang.String languageId,
                           java.lang.String description,
                           java.lang.String type,
                           boolean hidden,
                           java.lang.String friendlyURL)
                    throws com.liferay.portal.SystemException,
                           com.liferay.portal.PortalException,
                           java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateLayout

public Layout updateLayout(long groupId,
                           boolean privateLayout,
                           long layoutId,
                           long parentLayoutId,
                           java.lang.String name,
                           java.lang.String title,
                           java.lang.String languageId,
                           java.lang.String description,
                           java.lang.String type,
                           boolean hidden,
                           java.lang.String friendlyURL,
                           java.lang.Boolean iconImage,
                           byte[] iconBytes)
                    throws com.liferay.portal.SystemException,
                           com.liferay.portal.PortalException,
                           java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateLayout

public Layout updateLayout(long groupId,
                           boolean privateLayout,
                           long layoutId,
                           java.lang.String typeSettings)
                    throws com.liferay.portal.SystemException,
                           com.liferay.portal.PortalException,
                           java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateLookAndFeel

public Layout updateLookAndFeel(long groupId,
                                boolean privateLayout,
                                long layoutId,
                                java.lang.String themeId,
                                java.lang.String colorSchemeId,
                                java.lang.String css,
                                boolean wapTheme)
                         throws com.liferay.portal.SystemException,
                                com.liferay.portal.PortalException,
                                java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateName

public Layout updateName(long plid,
                         java.lang.String name,
                         java.lang.String languageId)
                  throws com.liferay.portal.SystemException,
                         com.liferay.portal.PortalException,
                         java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateName

public Layout updateName(long groupId,
                         boolean privateLayout,
                         long layoutId,
                         java.lang.String name,
                         java.lang.String languageId)
                  throws com.liferay.portal.SystemException,
                         com.liferay.portal.PortalException,
                         java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateParentLayoutId

public Layout updateParentLayoutId(long plid,
                                   long parentPlid)
                            throws com.liferay.portal.SystemException,
                                   com.liferay.portal.PortalException,
                                   java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateParentLayoutId

public Layout updateParentLayoutId(long groupId,
                                   boolean privateLayout,
                                   long layoutId,
                                   long parentLayoutId)
                            throws com.liferay.portal.SystemException,
                                   com.liferay.portal.PortalException,
                                   java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updatePriority

public Layout updatePriority(long plid,
                             int priority)
                      throws com.liferay.portal.SystemException,
                             com.liferay.portal.PortalException,
                             java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updatePriority

public Layout updatePriority(long groupId,
                             boolean privateLayout,
                             long layoutId,
                             int priority)
                      throws com.liferay.portal.SystemException,
                             com.liferay.portal.PortalException,
                             java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException