Interface LayoutSetService
- All Superinterfaces:
BaseService
- All Known Implementing Classes:
LayoutSetServiceWrapper
@AccessControlled
@CTAware
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface LayoutSetService
extends BaseService
Provides the remote service interface for LayoutSet. 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:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionReturns the OSGi service identifier.voidupdateFaviconFileEntryId(long groupId, boolean privateLayout, long faviconFileEntryId) voidupdateLayoutSetPrototypeLinkEnabled(long groupId, boolean privateLayout, boolean layoutSetPrototypeLinkEnabled, String layoutSetPrototypeUuid) Updates the state of the layout set prototype link.voidupdateLogo(long groupId, boolean privateLayout, boolean hasLogo, byte[] bytes) voidupdateLogo(long groupId, boolean privateLayout, boolean hasLogo, File file) voidupdateLogo(long groupId, boolean privateLayout, boolean hasLogo, InputStream inputStream) voidupdateLogo(long groupId, boolean privateLayout, boolean hasLogo, InputStream inputStream, boolean cleanUpStream) updateLookAndFeel(long groupId, boolean privateLayout, String themeId, String colorSchemeId, String css) updateSettings(long groupId, boolean privateLayout, String settings) updateVirtualHosts(long groupId, boolean privateLayout, TreeMap<String, String> virtualHostnames)
-
Method Details
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
updateFaviconFileEntryId
void updateFaviconFileEntryId(long groupId, boolean privateLayout, long faviconFileEntryId) throws PortalException - Throws:
PortalException
-
updateLayoutSetPrototypeLinkEnabled
void updateLayoutSetPrototypeLinkEnabled(long groupId, boolean privateLayout, boolean layoutSetPrototypeLinkEnabled, String layoutSetPrototypeUuid) throws PortalException Updates the state of the layout set prototype link.Important: Setting
layoutSetPrototypeLinkEnabledtotrueandlayoutSetPrototypeUuidtonullwhen the layout set prototype's current uuid isnullwill result in anIllegalStateException.- Parameters:
groupId- the primary key of the groupprivateLayout- whether the layout set is private to the grouplayoutSetPrototypeLinkEnabled- whether the layout set prototype is link enabledlayoutSetPrototypeUuid- the uuid of the layout set prototype to link with- Throws:
PortalException
-
updateLogo
void updateLogo(long groupId, boolean privateLayout, boolean hasLogo, byte[] bytes) throws PortalException - Throws:
PortalException
-
updateLogo
void updateLogo(long groupId, boolean privateLayout, boolean hasLogo, File file) throws PortalException - Throws:
PortalException
-
updateLogo
void updateLogo(long groupId, boolean privateLayout, boolean hasLogo, InputStream inputStream) throws PortalException - Throws:
PortalException
-
updateLogo
void updateLogo(long groupId, boolean privateLayout, boolean hasLogo, InputStream inputStream, boolean cleanUpStream) throws PortalException - Throws:
PortalException
-
updateLookAndFeel
LayoutSet updateLookAndFeel(long groupId, boolean privateLayout, String themeId, String colorSchemeId, String css) throws PortalException - Throws:
PortalException
-
updateSettings
LayoutSet updateSettings(long groupId, boolean privateLayout, String settings) throws PortalException - Throws:
PortalException
-
updateVirtualHosts
LayoutSet updateVirtualHosts(long groupId, boolean privateLayout, TreeMap<String, String> virtualHostnames) throws PortalException- Throws:
PortalException
-