Liferay 7.0-ce-b4

com.liferay.portal.service
Class LayoutSetLocalServiceUtil

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

@ProviderType
public class LayoutSetLocalServiceUtil
extends Object

Provides the local service utility for LayoutSet. This utility wraps LayoutSetLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
static DynamicQuery dynamicQuery()
           
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
static LayoutSet fetchLayoutSet(long layoutSetId)
           
static LayoutSet fetchLayoutSet(String virtualHostname)
           
static ActionableDynamicQuery getActionableDynamicQuery()
           
static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
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 String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static LayoutSetLocalService getService()
           
static LayoutSet updateLayoutSet(LayoutSet layoutSet)
          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, byte[] bytes)
           
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(long groupId,
                                     boolean privateLayout)
                              throws PortalException
Throws:
PortalException

addLayoutSet

public static LayoutSet addLayoutSet(LayoutSet layoutSet)
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

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 void deleteLayoutSet(long groupId,
                                   boolean privateLayout,
                                   ServiceContext serviceContext)
                            throws PortalException
Throws:
PortalException

deleteLayoutSet

public static LayoutSet deleteLayoutSet(LayoutSet layoutSet)
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

deleteLayoutSet

public static LayoutSet deleteLayoutSet(long layoutSetId)
                                 throws PortalException
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

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
Throws:
PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end)
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LayoutSetModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end,
                                       OrderByComparator<T> orderByComparator)
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LayoutSetModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows matching the dynamic query

fetchLayoutSet

public static LayoutSet fetchLayoutSet(long layoutSetId)

fetchLayoutSet

public static LayoutSet fetchLayoutSet(String virtualHostname)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLayoutSet

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

getLayoutSet

public static LayoutSet getLayoutSet(long layoutSetId)
                              throws PortalException
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

getLayoutSet

public static LayoutSet getLayoutSet(String virtualHostname)
                              throws PortalException
Throws:
PortalException

getLayoutSets

public static List<LayoutSet> getLayoutSets(int start,
                                            int end)
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LayoutSetModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

getLayoutSetsByLayoutSetPrototypeUuid

public static List<LayoutSet> getLayoutSetsByLayoutSetPrototypeUuid(String layoutSetPrototypeUuid)

getLayoutSetsCount

public static int getLayoutSetsCount()
Returns the number of layout sets.

Returns:
the number of layout sets

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
Throws:
PortalException

updateLayoutSet

public static LayoutSet updateLayoutSet(LayoutSet layoutSet)
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

updateLayoutSetPrototypeLinkEnabled

@Deprecated
public static void updateLayoutSetPrototypeLinkEnabled(long groupId,
                                                                  boolean privateLayout,
                                                                  boolean layoutSetPrototypeLinkEnabled)
                                                throws PortalException
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

updateLayoutSetPrototypeLinkEnabled

public static void updateLayoutSetPrototypeLinkEnabled(long groupId,
                                                       boolean privateLayout,
                                                       boolean layoutSetPrototypeLinkEnabled,
                                                       String layoutSetPrototypeUuid)
                                                throws PortalException
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

updateLogo

public static LayoutSet updateLogo(long groupId,
                                   boolean privateLayout,
                                   boolean logo,
                                   byte[] bytes)
                            throws PortalException
Throws:
PortalException

updateLogo

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

updateLogo

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

updateLogo

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

updateLookAndFeel

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

updateLookAndFeel

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

updatePageCount

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

updateSettings

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

updateVirtualHost

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

getService

public static LayoutSetLocalService getService()

Liferay 7.0-ce-b4