com.liferay.portal.service
Interface LayoutService
- All Known Implementing Classes:
- LayoutServiceBaseImpl, LayoutServiceImpl, LayoutServiceWrapper
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface LayoutService
The interface for the layout remote service.
Never modify or reference this interface directly. Always use LayoutServiceUtil
to access the layout remote service. Add custom service methods to LayoutServiceImpl
and rerun ServiceBuilder to automatically copy the method declarations to this interface.
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:
LayoutServiceUtil
,
LayoutServiceBaseImpl
,
LayoutServiceImpl
- ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.
Method Summary |
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)
|
Layout |
addLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
String name,
String title,
String description,
String type,
boolean hidden,
String friendlyURL,
ServiceContext serviceContext)
|
void |
deleteLayout(long plid)
|
void |
deleteLayout(long groupId,
boolean privateLayout,
long layoutId)
|
byte[] |
exportLayouts(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
byte[] |
exportLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
File |
exportLayoutsAsFile(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
byte[] |
exportPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
File |
exportPortletInfoAsFile(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
String |
getLayoutName(long groupId,
boolean privateLayout,
long layoutId,
String languageId)
|
LayoutReference[] |
getLayoutReferences(long companyId,
String portletId,
String preferencesKey,
String preferencesValue)
|
void |
importLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
byte[] bytes)
|
void |
importLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
|
void |
importLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream is)
|
void |
importPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
|
void |
importPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
|
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)
|
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)
|
void |
setLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
long[] layoutIds)
|
void |
unschedulePublishToLive(long groupId,
String jobName,
String groupName)
|
void |
unschedulePublishToRemote(long groupId,
String jobName,
String groupName)
|
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)
|
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)
|
Layout |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
String typeSettings)
|
Layout |
updateLookAndFeel(long groupId,
boolean privateLayout,
long layoutId,
String themeId,
String colorSchemeId,
String css,
boolean wapTheme)
|
Layout |
updateName(long groupId,
boolean privateLayout,
long layoutId,
String name,
String languageId)
|
Layout |
updateName(long plid,
String name,
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)
|
addLayout
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
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
void deleteLayout(long plid)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
deleteLayout
void deleteLayout(long groupId,
boolean privateLayout,
long layoutId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
exportLayouts
byte[] exportLayouts(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
exportLayouts
byte[] exportLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
exportLayoutsAsFile
File exportLayoutsAsFile(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
exportPortletInfo
byte[] exportPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
exportPortletInfoAsFile
File exportPortletInfoAsFile(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
getLayoutName
@Transactional(propagation=SUPPORTS,
readOnly=true)
String getLayoutName(long groupId,
boolean privateLayout,
long layoutId,
String languageId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
getLayoutReferences
@Transactional(propagation=SUPPORTS,
readOnly=true)
LayoutReference[] getLayoutReferences(long companyId,
String portletId,
String preferencesKey,
String preferencesValue)
throws SystemException
- Throws:
SystemException
importLayouts
void importLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
byte[] bytes)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
importLayouts
void importLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
importLayouts
void importLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream is)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
importPortletInfo
void importPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
importPortletInfo
void importPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
schedulePublishToLive
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
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
void setLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
long[] layoutIds)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
unschedulePublishToLive
void unschedulePublishToLive(long groupId,
String jobName,
String groupName)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
unschedulePublishToRemote
void unschedulePublishToRemote(long groupId,
String jobName,
String groupName)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
updateLayout
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
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
Layout updateLayout(long groupId,
boolean privateLayout,
long layoutId,
String typeSettings)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
updateLookAndFeel
Layout updateLookAndFeel(long groupId,
boolean privateLayout,
long layoutId,
String themeId,
String colorSchemeId,
String css,
boolean wapTheme)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
updateName
Layout updateName(long groupId,
boolean privateLayout,
long layoutId,
String name,
String languageId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
updateName
Layout updateName(long plid,
String name,
String languageId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
updateParentLayoutId
Layout updateParentLayoutId(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
updateParentLayoutId
Layout updateParentLayoutId(long plid,
long parentPlid)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
updatePriority
Layout updatePriority(long groupId,
boolean privateLayout,
long layoutId,
int priority)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
updatePriority
Layout updatePriority(long plid,
int priority)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException