Liferay 6.0.5

com.liferay.portal.service
Class LayoutServiceUtil

java.lang.Object
  extended by com.liferay.portal.service.LayoutServiceUtil

public class LayoutServiceUtil
extends Object

The utility for the layout remote service. This utility wraps LayoutServiceImpl and is the primary access point for service operations in application layer code running on a remote server.

Never modify this class directly. Add custom service methods to LayoutServiceImpl and rerun ServiceBuilder to regenerate this class.

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.

See Also:
LayoutService, LayoutServiceBaseImpl, LayoutServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
LayoutServiceUtil()
           
 
Method Summary
static Layout addLayout(long groupId, boolean privateLayout, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, String description, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext)
           
static Layout addLayout(long groupId, boolean privateLayout, long parentLayoutId, String name, String title, String description, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext)
           
static void deleteLayout(long plid)
           
static void deleteLayout(long groupId, boolean privateLayout, long layoutId)
           
static byte[] exportLayouts(long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate)
           
static byte[] exportLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, Date startDate, Date endDate)
           
static File exportLayoutsAsFile(long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate)
           
static byte[] exportPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate)
           
static File exportPortletInfoAsFile(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate)
           
static String getLayoutName(long groupId, boolean privateLayout, long layoutId, String languageId)
           
static LayoutReference[] getLayoutReferences(long companyId, String portletId, String preferencesKey, String preferencesValue)
           
static LayoutService getService()
           
static void importLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, byte[] bytes)
           
static void importLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file)
           
static void importLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream is)
           
static void importPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file)
           
static void importPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream is)
           
static void schedulePublishToLive(long sourceGroupId, long targetGroupId, boolean privateLayout, Map<Long,Boolean> layoutIdMap, Map<String,String[]> parameterMap, String scope, Date startDate, Date endDate, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description)
           
static void schedulePublishToRemote(long sourceGroupId, boolean privateLayout, Map<Long,Boolean> layoutIdMap, Map<String,String[]> parameterMap, String remoteAddress, int remotePort, boolean secureConnection, long remoteGroupId, boolean remotePrivateLayout, Date startDate, Date endDate, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description)
           
static void setLayouts(long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds)
           
 void setService(LayoutService service)
           
static void unschedulePublishToLive(long groupId, String jobName, String groupName)
           
static void unschedulePublishToRemote(long groupId, String jobName, String groupName)
           
static Layout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, String description, String type, boolean hidden, String friendlyURL, Boolean iconImage, byte[] iconBytes, ServiceContext serviceContext)
           
static Layout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, String description, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext)
           
static Layout updateLayout(long groupId, boolean privateLayout, long layoutId, String typeSettings)
           
static Layout updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, String themeId, String colorSchemeId, String css, boolean wapTheme)
           
static Layout updateName(long groupId, boolean privateLayout, long layoutId, String name, String languageId)
           
static Layout updateName(long plid, String name, String languageId)
           
static Layout updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId)
           
static Layout updateParentLayoutId(long plid, long parentPlid)
           
static Layout updatePriority(long groupId, boolean privateLayout, long layoutId, int priority)
           
static Layout updatePriority(long plid, int priority)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LayoutServiceUtil

public LayoutServiceUtil()
Method Detail

addLayout

public static Layout addLayout(long groupId,
                               boolean privateLayout,
                               long parentLayoutId,
                               Map<Locale,String> localeNamesMap,
                               Map<Locale,String> localeTitlesMap,
                               String description,
                               String type,
                               boolean hidden,
                               String friendlyURL,
                               ServiceContext serviceContext)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

addLayout

public static Layout addLayout(long groupId,
                               boolean privateLayout,
                               long parentLayoutId,
                               String name,
                               String title,
                               String description,
                               String type,
                               boolean hidden,
                               String friendlyURL,
                               ServiceContext serviceContext)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

deleteLayout

public static void deleteLayout(long plid)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

deleteLayout

public static void deleteLayout(long groupId,
                                boolean privateLayout,
                                long layoutId)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

exportLayouts

public static byte[] exportLayouts(long groupId,
                                   boolean privateLayout,
                                   long[] layoutIds,
                                   Map<String,String[]> parameterMap,
                                   Date startDate,
                                   Date endDate)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

exportLayouts

public static byte[] exportLayouts(long groupId,
                                   boolean privateLayout,
                                   Map<String,String[]> parameterMap,
                                   Date startDate,
                                   Date endDate)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

exportLayoutsAsFile

public static File exportLayoutsAsFile(long groupId,
                                       boolean privateLayout,
                                       long[] layoutIds,
                                       Map<String,String[]> parameterMap,
                                       Date startDate,
                                       Date endDate)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

exportPortletInfo

public static byte[] exportPortletInfo(long plid,
                                       long groupId,
                                       String portletId,
                                       Map<String,String[]> parameterMap,
                                       Date startDate,
                                       Date endDate)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

exportPortletInfoAsFile

public static File exportPortletInfoAsFile(long plid,
                                           long groupId,
                                           String portletId,
                                           Map<String,String[]> parameterMap,
                                           Date startDate,
                                           Date endDate)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

getLayoutName

public static String getLayoutName(long groupId,
                                   boolean privateLayout,
                                   long layoutId,
                                   String languageId)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

getLayoutReferences

public static LayoutReference[] getLayoutReferences(long companyId,
                                                    String portletId,
                                                    String preferencesKey,
                                                    String preferencesValue)
                                             throws SystemException
Throws:
SystemException

importLayouts

public static void importLayouts(long groupId,
                                 boolean privateLayout,
                                 Map<String,String[]> parameterMap,
                                 byte[] bytes)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

importLayouts

public static void importLayouts(long groupId,
                                 boolean privateLayout,
                                 Map<String,String[]> parameterMap,
                                 File file)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

importLayouts

public static void importLayouts(long groupId,
                                 boolean privateLayout,
                                 Map<String,String[]> parameterMap,
                                 InputStream is)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

importPortletInfo

public static void importPortletInfo(long plid,
                                     long groupId,
                                     String portletId,
                                     Map<String,String[]> parameterMap,
                                     File file)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

importPortletInfo

public static void importPortletInfo(long plid,
                                     long groupId,
                                     String portletId,
                                     Map<String,String[]> parameterMap,
                                     InputStream is)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

schedulePublishToLive

public static void schedulePublishToLive(long sourceGroupId,
                                         long targetGroupId,
                                         boolean privateLayout,
                                         Map<Long,Boolean> layoutIdMap,
                                         Map<String,String[]> parameterMap,
                                         String scope,
                                         Date startDate,
                                         Date endDate,
                                         String groupName,
                                         String cronText,
                                         Date schedulerStartDate,
                                         Date schedulerEndDate,
                                         String description)
                                  throws PortalException,
                                         SystemException
Throws:
PortalException
SystemException

schedulePublishToRemote

public static void schedulePublishToRemote(long sourceGroupId,
                                           boolean privateLayout,
                                           Map<Long,Boolean> layoutIdMap,
                                           Map<String,String[]> parameterMap,
                                           String remoteAddress,
                                           int remotePort,
                                           boolean secureConnection,
                                           long remoteGroupId,
                                           boolean remotePrivateLayout,
                                           Date startDate,
                                           Date endDate,
                                           String groupName,
                                           String cronText,
                                           Date schedulerStartDate,
                                           Date schedulerEndDate,
                                           String description)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

setLayouts

public static void setLayouts(long groupId,
                              boolean privateLayout,
                              long parentLayoutId,
                              long[] layoutIds)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

unschedulePublishToLive

public static void unschedulePublishToLive(long groupId,
                                           String jobName,
                                           String groupName)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

unschedulePublishToRemote

public static void unschedulePublishToRemote(long groupId,
                                             String jobName,
                                             String groupName)
                                      throws PortalException,
                                             SystemException
Throws:
PortalException
SystemException

updateLayout

public static Layout updateLayout(long groupId,
                                  boolean privateLayout,
                                  long layoutId,
                                  long parentLayoutId,
                                  Map<Locale,String> localeNamesMap,
                                  Map<Locale,String> localeTitlesMap,
                                  String description,
                                  String type,
                                  boolean hidden,
                                  String friendlyURL,
                                  Boolean iconImage,
                                  byte[] iconBytes,
                                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

updateLayout

public static Layout updateLayout(long groupId,
                                  boolean privateLayout,
                                  long layoutId,
                                  long parentLayoutId,
                                  Map<Locale,String> localeNamesMap,
                                  Map<Locale,String> localeTitlesMap,
                                  String description,
                                  String type,
                                  boolean hidden,
                                  String friendlyURL,
                                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

updateLayout

public static Layout updateLayout(long groupId,
                                  boolean privateLayout,
                                  long layoutId,
                                  String typeSettings)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

updateLookAndFeel

public static Layout updateLookAndFeel(long groupId,
                                       boolean privateLayout,
                                       long layoutId,
                                       String themeId,
                                       String colorSchemeId,
                                       String css,
                                       boolean wapTheme)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

updateName

public static Layout updateName(long groupId,
                                boolean privateLayout,
                                long layoutId,
                                String name,
                                String languageId)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

updateName

public static Layout updateName(long plid,
                                String name,
                                String languageId)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

updateParentLayoutId

public static Layout updateParentLayoutId(long groupId,
                                          boolean privateLayout,
                                          long layoutId,
                                          long parentLayoutId)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

updateParentLayoutId

public static Layout updateParentLayoutId(long plid,
                                          long parentPlid)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

updatePriority

public static Layout updatePriority(long groupId,
                                    boolean privateLayout,
                                    long layoutId,
                                    int priority)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

updatePriority

public static Layout updatePriority(long plid,
                                    int priority)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

getService

public static LayoutService getService()

setService

public void setService(LayoutService service)

Liferay 6.0.5