com.liferay.portal.kernel.service

Interface LayoutSetService

All Superinterfaces:

BaseService

All Known Implementing Classes:

LayoutSetServiceWrapper

@AccessControlled
 @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:

LayoutSetServiceUtil

{$generated.description}

Method Summary

Modifier and Type	Method and Description
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
void	updateLayoutSetPrototypeLinkEnabled(long groupId, boolean privateLayout, boolean layoutSetPrototypeLinkEnabled, String layoutSetPrototypeUuid) Updates the state of the layout set prototype link.
void	updateLogo(long groupId, boolean privateLayout, boolean hasLogo, byte[] bytes)
void	updateLogo(long groupId, boolean privateLayout, boolean hasLogo, File file)
void	updateLogo(long groupId, boolean privateLayout, boolean hasLogo, InputStream inputStream)
void	updateLogo(long groupId, boolean privateLayout, boolean hasLogo, InputStream inputStream, boolean cleanUpStream)
LayoutSet	updateLookAndFeel(long groupId, boolean privateLayout, String themeId, String colorSchemeId, String css)
LayoutSet	updateSettings(long groupId, boolean privateLayout, String settings)
LayoutSet	updateVirtualHost(long groupId, boolean privateLayout, String virtualHost)

Method Detail

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

updateLayoutSetPrototypeLinkEnabled

void updateLayoutSetPrototypeLinkEnabled(long groupId,
                                         boolean privateLayout,
                                         boolean layoutSetPrototypeLinkEnabled,
                                         String layoutSetPrototypeUuid)
                                  throws PortalException

Updates the state of the layout set prototype link.

Important: Setting layoutSetPrototypeLinkEnabled to true and layoutSetPrototypeUuid to null when the layout set prototype's current uuid is null will result in an IllegalStateException.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout set is private to the group

layoutSetPrototypeLinkEnabled - whether the layout set prototype is link enabled

layoutSetPrototypeUuid - 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

updateVirtualHost

LayoutSet updateVirtualHost(long groupId,
                            boolean privateLayout,
                            String virtualHost)
                     throws PortalException

Throws:

PortalException