com.liferay.portal.service
Class LayoutSetLocalServiceUtil

java.lang.Object
  com.liferay.portal.service.LayoutSetLocalServiceUtil

public class LayoutSetLocalServiceUtil
extends Object

The utility for the layout set local service. This utility wraps LayoutSetLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

LayoutSetLocalService, LayoutSetLocalServiceBaseImpl, LayoutSetLocalServiceImpl

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

Constructor Summary

LayoutSetLocalServiceUtil()

Method Summary

static LayoutSet	addLayoutSet(LayoutSet layoutSet) Adds the layout set to the database.
static LayoutSet	addLayoutSet(long groupId, boolean privateLayout)
static LayoutSet	createLayoutSet(long layoutSetId) Creates a new layout set with the primary key.
static LayoutSet	deleteLayoutSet(LayoutSet layoutSet) Deletes the layout set from the database.
static LayoutSet	deleteLayoutSet(long layoutSetId) Deletes the layout set with the primary key from the database.
static void	deleteLayoutSet(long groupId, boolean privateLayout, ServiceContext serviceContext)
static DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
static LayoutSet	fetchLayoutSet(long layoutSetId)
static LayoutSet	fetchLayoutSet(String virtualHostname)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static LayoutSet	getLayoutSet(long layoutSetId) Returns the layout set with the primary key.
static LayoutSet	getLayoutSet(long groupId, boolean privateLayout)
static LayoutSet	getLayoutSet(String virtualHostname)
static List<LayoutSet>	getLayoutSets(int start, int end) Returns a range of all the layout sets.
static List<LayoutSet>	getLayoutSetsByLayoutSetPrototypeUuid(String layoutSetPrototypeUuid)
static int	getLayoutSetsCount() Returns the number of layout sets.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static LayoutSetLocalService	getService()
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(LayoutSetLocalService service) Deprecated.
static LayoutSet	updateLayoutSet(LayoutSet layoutSet) Updates the layout set in the database or adds it if it does not yet exist.
static LayoutSet	updateLayoutSet(LayoutSet layoutSet, boolean merge) Updates the layout set in the database or adds it if it does not yet exist.
static void	updateLayoutSetPrototypeLinkEnabled(long groupId, boolean privateLayout, boolean layoutSetPrototypeLinkEnabled) Deprecated. As of 6.1.0, replaced by updateLayoutSetPrototypeLinkEnabled(long, boolean, boolean, String)
static void	updateLayoutSetPrototypeLinkEnabled(long groupId, boolean privateLayout, boolean layoutSetPrototypeLinkEnabled, String layoutSetPrototypeUuid) Updates the state of the layout set prototype link.
static LayoutSet	updateLogo(long groupId, boolean privateLayout, boolean logo, File file)
static LayoutSet	updateLogo(long groupId, boolean privateLayout, boolean logo, InputStream is)
static LayoutSet	updateLogo(long groupId, boolean privateLayout, boolean logo, InputStream is, boolean cleanUpStream)
static LayoutSet	updateLookAndFeel(long groupId, boolean privateLayout, String themeId, String colorSchemeId, String css, boolean wapTheme)
static void	updateLookAndFeel(long groupId, String themeId, String colorSchemeId, String css, boolean wapTheme)
static LayoutSet	updatePageCount(long groupId, boolean privateLayout)
static LayoutSet	updateSettings(long groupId, boolean privateLayout, String settings)
static LayoutSet	updateVirtualHost(long groupId, boolean privateLayout, String virtualHostname)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LayoutSetLocalServiceUtil

public LayoutSetLocalServiceUtil()

Method Detail

addLayoutSet

public static LayoutSet addLayoutSet(LayoutSet layoutSet)
                              throws SystemException

Adds the layout set to the database. Also notifies the appropriate model listeners.

Parameters:

layoutSet - the layout set

Returns:

the layout set that was added

Throws:

SystemException - if a system exception occurred

createLayoutSet

public static LayoutSet createLayoutSet(long layoutSetId)

Creates a new layout set with the primary key. Does not add the layout set to the database.

Parameters:

layoutSetId - the primary key for the new layout set

Returns:

the new layout set

deleteLayoutSet

public static LayoutSet deleteLayoutSet(long layoutSetId)
                                 throws PortalException,
                                        SystemException

Deletes the layout set with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

layoutSetId - the primary key of the layout set

Returns:

the layout set that was removed

Throws:

PortalException - if a layout set with the primary key could not be found

SystemException - if a system exception occurred

deleteLayoutSet

public static LayoutSet deleteLayoutSet(LayoutSet layoutSet)
                                 throws SystemException

Deletes the layout set from the database. Also notifies the appropriate model listeners.

Parameters:

layoutSet - the layout set

Returns:

the layout set that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchLayoutSet

public static LayoutSet fetchLayoutSet(long layoutSetId)
                                throws SystemException

Throws:

SystemException

getLayoutSet

public static LayoutSet getLayoutSet(long layoutSetId)
                              throws PortalException,
                                     SystemException

Returns the layout set with the primary key.

Parameters:

layoutSetId - the primary key of the layout set

Returns:

the layout set

Throws:

PortalException - if a layout set with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getLayoutSets

public static List<LayoutSet> getLayoutSets(int start,
                                            int end)
                                     throws SystemException

Returns a range of all the layout sets.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

start - the lower bound of the range of layout sets

end - the upper bound of the range of layout sets (not inclusive)

Returns:

the range of layout sets

Throws:

SystemException - if a system exception occurred

getLayoutSetsCount

public static int getLayoutSetsCount()
                              throws SystemException

Returns the number of layout sets.

Returns:

the number of layout sets

Throws:

SystemException - if a system exception occurred

updateLayoutSet

public static LayoutSet updateLayoutSet(LayoutSet layoutSet)
                                 throws SystemException

Updates the layout set in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

layoutSet - the layout set

Returns:

the layout set that was updated

Throws:

SystemException - if a system exception occurred

updateLayoutSet

public static LayoutSet updateLayoutSet(LayoutSet layoutSet,
                                        boolean merge)
                                 throws SystemException

Updates the layout set in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

layoutSet - the layout set

merge - whether to merge the layout set with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the layout set that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addLayoutSet

public static LayoutSet addLayoutSet(long groupId,
                                     boolean privateLayout)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

deleteLayoutSet

public static void deleteLayoutSet(long groupId,
                                   boolean privateLayout,
                                   ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

fetchLayoutSet

public static LayoutSet fetchLayoutSet(String virtualHostname)
                                throws SystemException

Throws:

SystemException

getLayoutSet

public static LayoutSet getLayoutSet(long groupId,
                                     boolean privateLayout)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

getLayoutSet

public static LayoutSet getLayoutSet(String virtualHostname)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

getLayoutSetsByLayoutSetPrototypeUuid

public static List<LayoutSet> getLayoutSetsByLayoutSetPrototypeUuid(String layoutSetPrototypeUuid)
                                                             throws SystemException

Throws:

SystemException

updateLayoutSetPrototypeLinkEnabled

public static void updateLayoutSetPrototypeLinkEnabled(long groupId,
                                                       boolean privateLayout,
                                                       boolean layoutSetPrototypeLinkEnabled)
                                                throws PortalException,
                                                       SystemException

Deprecated. As of 6.1.0, replaced by updateLayoutSetPrototypeLinkEnabled(long, boolean, boolean, String)

Updates the state of the layout set prototype link.

This method can disable the layout set prototype's link by setting layoutSetPrototypeLinkEnabled to false. However, this method can only enable the layout set prototype's link if the layout set prototype's current uuid is not null. Setting the layoutSetPrototypeLinkEnabled to true when the layout set prototype's current uuid is null will have no effect.

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

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

updateLayoutSetPrototypeLinkEnabled

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

Updates the state of the layout set prototype link.

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 - if a portal exception occurred

SystemException - if a system exception occurred

updateLogo

public static LayoutSet updateLogo(long groupId,
                                   boolean privateLayout,
                                   boolean logo,
                                   File file)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

updateLogo

public static LayoutSet updateLogo(long groupId,
                                   boolean privateLayout,
                                   boolean logo,
                                   InputStream is)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

updateLogo

public static LayoutSet updateLogo(long groupId,
                                   boolean privateLayout,
                                   boolean logo,
                                   InputStream is,
                                   boolean cleanUpStream)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

updateLookAndFeel

public static LayoutSet updateLookAndFeel(long groupId,
                                          boolean privateLayout,
                                          String themeId,
                                          String colorSchemeId,
                                          String css,
                                          boolean wapTheme)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

updateLookAndFeel

public static void updateLookAndFeel(long groupId,
                                     String themeId,
                                     String colorSchemeId,
                                     String css,
                                     boolean wapTheme)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

updatePageCount

public static LayoutSet updatePageCount(long groupId,
                                        boolean privateLayout)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

updateSettings

public static LayoutSet updateSettings(long groupId,
                                       boolean privateLayout,
                                       String settings)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

updateVirtualHost

public static LayoutSet updateVirtualHost(long groupId,
                                          boolean privateLayout,
                                          String virtualHostname)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getService

public static LayoutSetLocalService getService()

setService

public void setService(LayoutSetLocalService service)

Deprecated.