Class LayoutSetBranchLocalServiceUtil

Object
com.liferay.portal.kernel.service.LayoutSetBranchLocalServiceUtil

public class LayoutSetBranchLocalServiceUtil extends Object
Provides the local service utility for LayoutSetBranch. This utility wraps com.liferay.portal.service.impl.LayoutSetBranchLocalServiceImpl 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

    • LayoutSetBranchLocalServiceUtil

      public LayoutSetBranchLocalServiceUtil()
  • Method Details

    • addLayoutSetBranch

      public static LayoutSetBranch addLayoutSetBranch(LayoutSetBranch layoutSetBranch)
      Adds the layout set branch to the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutSetBranchLocalServiceImpl 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:
      layoutSetBranch - the layout set branch
      Returns:
      the layout set branch that was added
    • addLayoutSetBranch

      public static LayoutSetBranch addLayoutSetBranch(long userId, long groupId, boolean privateLayout, String name, String description, boolean master, long copyLayoutSetBranchId, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • createLayoutSetBranch

      public static LayoutSetBranch createLayoutSetBranch(long layoutSetBranchId)
      Creates a new layout set branch with the primary key. Does not add the layout set branch to the database.
      Parameters:
      layoutSetBranchId - the primary key for the new layout set branch
      Returns:
      the new layout set branch
    • createPersistedModel

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

      public static LayoutSetBranch deleteLayoutSetBranch(LayoutSetBranch layoutSetBranch) throws PortalException
      Deletes the layout set branch from the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutSetBranchLocalServiceImpl 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:
      layoutSetBranch - the layout set branch
      Returns:
      the layout set branch that was removed
      Throws:
      PortalException
    • deleteLayoutSetBranch

      public static LayoutSetBranch deleteLayoutSetBranch(LayoutSetBranch layoutSetBranch, boolean includeMaster) throws PortalException
      Throws:
      PortalException
    • deleteLayoutSetBranch

      public static LayoutSetBranch deleteLayoutSetBranch(long layoutSetBranchId) throws PortalException
      Deletes the layout set branch with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutSetBranchLocalServiceImpl 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:
      layoutSetBranchId - the primary key of the layout set branch
      Returns:
      the layout set branch that was removed
      Throws:
      PortalException - if a layout set branch with the primary key could not be found
    • deleteLayoutSetBranch

      public static LayoutSetBranch deleteLayoutSetBranch(long currentLayoutPlid, LayoutSetBranch layoutSetBranch, boolean includeMaster) throws PortalException
      Throws:
      PortalException
    • deleteLayoutSetBranch

      public static LayoutSetBranch deleteLayoutSetBranch(long currentLayoutPlid, long layoutSetBranchId) throws PortalException
      Throws:
      PortalException
    • deleteLayoutSetBranches

      public static void deleteLayoutSetBranches(long groupId, boolean privateLayout) throws PortalException
      Throws:
      PortalException
    • deleteLayoutSetBranches

      public static void deleteLayoutSetBranches(long groupId, boolean privateLayout, boolean includeMaster) 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.LayoutSetBranchModelImpl.

      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.LayoutSetBranchModelImpl.

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

      public static LayoutSetBranch fetchLayoutSetBranch(long layoutSetBranchId)
    • fetchLayoutSetBranch

      public static LayoutSetBranch fetchLayoutSetBranch(long groupId, boolean privateLayout, String name)
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getLayoutSetBranch

      public static LayoutSetBranch getLayoutSetBranch(long layoutSetBranchId) throws PortalException
      Returns the layout set branch with the primary key.
      Parameters:
      layoutSetBranchId - the primary key of the layout set branch
      Returns:
      the layout set branch
      Throws:
      PortalException - if a layout set branch with the primary key could not be found
    • getLayoutSetBranch

      public static LayoutSetBranch getLayoutSetBranch(long groupId, boolean privateLayout, String name) throws PortalException
      Throws:
      PortalException
    • getLayoutSetBranches

      public static List<LayoutSetBranch> getLayoutSetBranches(long groupId, boolean privateLayout)
    • getLayoutSetBranchs

      public static List<LayoutSetBranch> getLayoutSetBranchs(int start, int end)
      Returns a range of all the layout set branches.

      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.LayoutSetBranchModelImpl.

      Parameters:
      start - the lower bound of the range of layout set branches
      end - the upper bound of the range of layout set branches (not inclusive)
      Returns:
      the range of layout set branches
    • getLayoutSetBranchsCount

      public static int getLayoutSetBranchsCount()
      Returns the number of layout set branches.
      Returns:
      the number of layout set branches
    • getMasterLayoutSetBranch

      public static LayoutSetBranch getMasterLayoutSetBranch(long groupId, boolean privateLayout) throws PortalException
      Throws:
      PortalException
    • 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
    • getUserLayoutSetBranch

      public static LayoutSetBranch getUserLayoutSetBranch(long userId, long groupId, boolean privateLayout, long layoutSetId, long layoutSetBranchId) throws PortalException
      Throws:
      PortalException
    • mergeLayoutSetBranch

      public static LayoutSetBranch mergeLayoutSetBranch(long layoutSetBranchId, long mergeLayoutSetBranchId, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • updateLayoutSetBranch

      public static LayoutSetBranch updateLayoutSetBranch(LayoutSetBranch layoutSetBranch)
      Updates the layout set branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect LayoutSetBranchLocalServiceImpl 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:
      layoutSetBranch - the layout set branch
      Returns:
      the layout set branch that was updated
    • updateLayoutSetBranch

      public static LayoutSetBranch updateLayoutSetBranch(long layoutSetBranchId, String name, String description, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • getService

      public static LayoutSetBranchLocalService getService()
    • setService

      public static void setService(LayoutSetBranchLocalService service)