Class LayoutSetLocalServiceUtil

Object
com.liferay.portal.kernel.service.LayoutSetLocalServiceUtil

public class LayoutSetLocalServiceUtil extends Object
Provides the local service utility for LayoutSet. This utility wraps com.liferay.portal.service.impl.LayoutSetLocalServiceImpl and is an 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.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • LayoutSetLocalServiceUtil

      public LayoutSetLocalServiceUtil()
  • Method Details

    • addLayoutSet

      public static LayoutSet addLayoutSet(LayoutSet layoutSet)
      Adds the layout set to the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutSetLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      layoutSet - the layout set
      Returns:
      the layout set that was added
    • addLayoutSet

      public static LayoutSet addLayoutSet(long groupId, boolean privateLayout) throws PortalException
      Throws:
      PortalException
    • 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
    • createPersistedModel

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • deleteLayoutSet

      public static LayoutSet deleteLayoutSet(LayoutSet layoutSet)
      Deletes the layout set from the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutSetLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      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.

      Important: Inspect LayoutSetLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      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
    • deleteLayoutSet

      public static void deleteLayoutSet(long groupId, boolean privateLayout, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • deletePersistedModel

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

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.LayoutSetModelImpl.

      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.LayoutSetModelImpl.

      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(long groupId, boolean privateLayout)
    • fetchLayoutSet

      public static LayoutSet fetchLayoutSet(String virtualHostname)
    • fetchLayoutSetByLogoId

      public static LayoutSet fetchLayoutSetByLogoId(boolean privateLayout, long logoId) throws PortalException
      Throws:
      PortalException
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • 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(long groupId, boolean privateLayout) throws PortalException
      Throws:
      PortalException
    • 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.LayoutSetModelImpl.

      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
    • getPageCount

      public static int getPageCount(long groupId, boolean privateLayout)
    • getPersistedModel

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

      public static LayoutSet updateFaviconFileEntryId(long groupId, boolean privateLayout, long faviconFileEntryId) 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.

      Important: Inspect LayoutSetLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      layoutSet - the layout set
      Returns:
      the layout set that was updated
    • 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 hasLogo, byte[] bytes) throws PortalException
      Throws:
      PortalException
    • updateLogo

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

      public static LayoutSet updateLogo(long groupId, boolean privateLayout, boolean hasLogo, InputStream inputStream) throws PortalException
      Throws:
      PortalException
    • updateLogo

      public static LayoutSet updateLogo(long groupId, boolean privateLayout, boolean hasLogo, InputStream inputStream, boolean cleanUpStream) throws PortalException
      Throws:
      PortalException
    • updateLookAndFeel

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

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

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

      public static LayoutSet updateVirtualHosts(long groupId, boolean privateLayout, TreeMap<String,String> virtualHostnames) throws PortalException
      Throws:
      PortalException
    • getService

      public static LayoutSetLocalService getService()
    • setService

      public static void setService(LayoutSetLocalService service)