Interface RecentLayoutBranchLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
RecentLayoutBranchLocalServiceWrapper

Provides the local service interface for RecentLayoutBranch. 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}
  • Method Details

    • addRecentLayoutBranch

      RecentLayoutBranch addRecentLayoutBranch(long userId, long layoutBranchId, long layoutSetBranchId, long plid) throws PortalException
      Throws:
      PortalException
    • addRecentLayoutBranch

      @Indexable(type=REINDEX) RecentLayoutBranch addRecentLayoutBranch(RecentLayoutBranch recentLayoutBranch)
      Adds the recent layout branch to the database. Also notifies the appropriate model listeners.

      Important: Inspect RecentLayoutBranchLocalServiceImpl 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:
      recentLayoutBranch - the recent layout branch
      Returns:
      the recent layout branch that was added
    • createPersistedModel

      PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      createPersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • createRecentLayoutBranch

      @Transactional(enabled=false) RecentLayoutBranch createRecentLayoutBranch(long recentLayoutBranchId)
      Creates a new recent layout branch with the primary key. Does not add the recent layout branch to the database.
      Parameters:
      recentLayoutBranchId - the primary key for the new recent layout branch
      Returns:
      the new recent layout branch
    • deletePersistedModel

      PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Specified by:
      deletePersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • deleteRecentLayoutBranch

      @Indexable(type=DELETE) RecentLayoutBranch deleteRecentLayoutBranch(long recentLayoutBranchId) throws PortalException
      Deletes the recent layout branch with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect RecentLayoutBranchLocalServiceImpl 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:
      recentLayoutBranchId - the primary key of the recent layout branch
      Returns:
      the recent layout branch that was removed
      Throws:
      PortalException - if a recent layout branch with the primary key could not be found
    • deleteRecentLayoutBranch

      @Indexable(type=DELETE) RecentLayoutBranch deleteRecentLayoutBranch(RecentLayoutBranch recentLayoutBranch)
      Deletes the recent layout branch from the database. Also notifies the appropriate model listeners.

      Important: Inspect RecentLayoutBranchLocalServiceImpl 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:
      recentLayoutBranch - the recent layout branch
      Returns:
      the recent layout branch that was removed
    • deleteRecentLayoutBranches

      void deleteRecentLayoutBranches(long layoutBranchId)
    • deleteUserRecentLayoutBranches

      void deleteUserRecentLayoutBranches(long userId)
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface PersistedModelLocalService
    • dynamicQuery

    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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.RecentLayoutBranchModelImpl.

      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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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.RecentLayoutBranchModelImpl.

      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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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
    • fetchRecentLayoutBranch

      @Transactional(propagation=SUPPORTS, readOnly=true) RecentLayoutBranch fetchRecentLayoutBranch(long recentLayoutBranchId)
    • fetchRecentLayoutBranch

      @Transactional(propagation=SUPPORTS, readOnly=true) RecentLayoutBranch fetchRecentLayoutBranch(long userId, long layoutSetBranchId, long plid)
    • getActionableDynamicQuery

    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      @Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      getPersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • getRecentLayoutBranch

      @Transactional(propagation=SUPPORTS, readOnly=true) RecentLayoutBranch getRecentLayoutBranch(long recentLayoutBranchId) throws PortalException
      Returns the recent layout branch with the primary key.
      Parameters:
      recentLayoutBranchId - the primary key of the recent layout branch
      Returns:
      the recent layout branch
      Throws:
      PortalException - if a recent layout branch with the primary key could not be found
    • getRecentLayoutBranchs

      @Transactional(propagation=SUPPORTS, readOnly=true) List<RecentLayoutBranch> getRecentLayoutBranchs(int start, int end)
      Returns a range of all the recent layout 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.RecentLayoutBranchModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getRecentLayoutBranchsCount()
      Returns the number of recent layout branches.
      Returns:
      the number of recent layout branches
    • updateRecentLayoutBranch

      @Indexable(type=REINDEX) RecentLayoutBranch updateRecentLayoutBranch(RecentLayoutBranch recentLayoutBranch)
      Updates the recent layout branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect RecentLayoutBranchLocalServiceImpl 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:
      recentLayoutBranch - the recent layout branch
      Returns:
      the recent layout branch that was updated