Class BatchPlannerPlanLocalServiceUtil

java.lang.Object
com.liferay.batch.planner.service.BatchPlannerPlanLocalServiceUtil

public class BatchPlannerPlanLocalServiceUtil extends Object
Provides the local service utility for BatchPlannerPlan. This utility wraps com.liferay.batch.planner.service.impl.BatchPlannerPlanLocalServiceImpl 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.
See Also:
Generated:
  • Constructor Details

    • BatchPlannerPlanLocalServiceUtil

      public BatchPlannerPlanLocalServiceUtil()
  • Method Details

    • addBatchPlannerPlan

      public static BatchPlannerPlan addBatchPlannerPlan(BatchPlannerPlan batchPlannerPlan)
      Adds the batch planner plan to the database. Also notifies the appropriate model listeners.

      Important: Inspect BatchPlannerPlanLocalServiceImpl 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:
      batchPlannerPlan - the batch planner plan
      Returns:
      the batch planner plan that was added
    • addBatchPlannerPlan

      public static BatchPlannerPlan addBatchPlannerPlan(long userId, boolean export, String externalType, String externalURL, String internalClassName, String name, int size, String taskItemDelegateName, boolean template) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createBatchPlannerPlan

      public static BatchPlannerPlan createBatchPlannerPlan(long batchPlannerPlanId)
      Creates a new batch planner plan with the primary key. Does not add the batch planner plan to the database.
      Parameters:
      batchPlannerPlanId - the primary key for the new batch planner plan
      Returns:
      the new batch planner plan
    • createPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deactivateBatchPlannerPlan

      public static void deactivateBatchPlannerPlan(String batchEngineTaskERC)
    • deleteBatchPlannerPlan

      public static BatchPlannerPlan deleteBatchPlannerPlan(BatchPlannerPlan batchPlannerPlan) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the batch planner plan from the database. Also notifies the appropriate model listeners.

      Important: Inspect BatchPlannerPlanLocalServiceImpl 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:
      batchPlannerPlan - the batch planner plan
      Returns:
      the batch planner plan that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteBatchPlannerPlan

      public static BatchPlannerPlan deleteBatchPlannerPlan(long batchPlannerPlanId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the batch planner plan with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect BatchPlannerPlanLocalServiceImpl 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:
      batchPlannerPlanId - the primary key of the batch planner plan
      Returns:
      the batch planner plan that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a batch planner plan with the primary key could not be found
    • deletePersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.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.batch.planner.model.impl.BatchPlannerPlanModelImpl.

      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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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.batch.planner.model.impl.BatchPlannerPlanModelImpl.

      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(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.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
    • fetchBatchPlannerPlan

      public static BatchPlannerPlan fetchBatchPlannerPlan(long batchPlannerPlanId)
    • getActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getBatchPlannerPlan

      public static BatchPlannerPlan getBatchPlannerPlan(long batchPlannerPlanId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the batch planner plan with the primary key.
      Parameters:
      batchPlannerPlanId - the primary key of the batch planner plan
      Returns:
      the batch planner plan
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a batch planner plan with the primary key could not be found
    • getBatchPlannerPlans

      public static List<BatchPlannerPlan> getBatchPlannerPlans(int start, int end)
      Returns a range of all the batch planner plans.

      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.batch.planner.model.impl.BatchPlannerPlanModelImpl.

      Parameters:
      start - the lower bound of the range of batch planner plans
      end - the upper bound of the range of batch planner plans (not inclusive)
      Returns:
      the range of batch planner plans
    • getBatchPlannerPlansCount

      public static int getBatchPlannerPlansCount()
      Returns the number of batch planner plans.
      Returns:
      the number of batch planner plans
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateBatchPlannerPlan

      public static BatchPlannerPlan updateBatchPlannerPlan(BatchPlannerPlan batchPlannerPlan)
      Updates the batch planner plan in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect BatchPlannerPlanLocalServiceImpl 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:
      batchPlannerPlan - the batch planner plan
      Returns:
      the batch planner plan that was updated
    • updateBatchPlannerPlan

      public static BatchPlannerPlan updateBatchPlannerPlan(long batchPlannerPlanId, String externalType, String internalClassName, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStatus

      public static BatchPlannerPlan updateStatus(long batchPlannerPlanId, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static BatchPlannerPlanLocalService getService()