Class BatchPlannerMappingLocalServiceUtil

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

public class BatchPlannerMappingLocalServiceUtil extends Object
Provides the local service utility for BatchPlannerMapping. This utility wraps com.liferay.batch.planner.service.impl.BatchPlannerMappingLocalServiceImpl 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

    • BatchPlannerMappingLocalServiceUtil

      public BatchPlannerMappingLocalServiceUtil()
  • Method Details

    • addBatchPlannerMapping

      public static BatchPlannerMapping addBatchPlannerMapping(BatchPlannerMapping batchPlannerMapping)
      Adds the batch planner mapping to the database. Also notifies the appropriate model listeners.

      Important: Inspect BatchPlannerMappingLocalServiceImpl 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:
      batchPlannerMapping - the batch planner mapping
      Returns:
      the batch planner mapping that was added
    • addBatchPlannerMapping

      public static BatchPlannerMapping addBatchPlannerMapping(long userId, long batchPlannerPlanId, String externalFieldName, String externalFieldType, String internalFieldName, String internalFieldType, String script) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createBatchPlannerMapping

      public static BatchPlannerMapping createBatchPlannerMapping(long batchPlannerMappingId)
      Creates a new batch planner mapping with the primary key. Does not add the batch planner mapping to the database.
      Parameters:
      batchPlannerMappingId - the primary key for the new batch planner mapping
      Returns:
      the new batch planner mapping
    • 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
    • deleteBatchPlannerMapping

      public static BatchPlannerMapping deleteBatchPlannerMapping(BatchPlannerMapping batchPlannerMapping)
      Deletes the batch planner mapping from the database. Also notifies the appropriate model listeners.

      Important: Inspect BatchPlannerMappingLocalServiceImpl 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:
      batchPlannerMapping - the batch planner mapping
      Returns:
      the batch planner mapping that was removed
    • deleteBatchPlannerMapping

      public static BatchPlannerMapping deleteBatchPlannerMapping(long batchPlannerMappingId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the batch planner mapping with the primary key from the database. Also notifies the appropriate model listeners.

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

      public static BatchPlannerMapping deleteBatchPlannerMapping(long batchPlannerPlanId, String externalFieldName, String internalFieldName) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteBatchPlannerMappings

      public static void deleteBatchPlannerMappings(long batchPlannerPlanId)
    • 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.BatchPlannerMappingModelImpl.

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

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

      public static BatchPlannerMapping fetchBatchPlannerMapping(long batchPlannerMappingId)
    • getActionableDynamicQuery

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

      public static BatchPlannerMapping getBatchPlannerMapping(long batchPlannerMappingId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the batch planner mapping with the primary key.
      Parameters:
      batchPlannerMappingId - the primary key of the batch planner mapping
      Returns:
      the batch planner mapping
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a batch planner mapping with the primary key could not be found
    • getBatchPlannerMappings

      public static List<BatchPlannerMapping> getBatchPlannerMappings(int start, int end)
      Returns a range of all the batch planner mappings.

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

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

      public static List<BatchPlannerMapping> getBatchPlannerMappings(long batchPlannerPlanId)
    • getBatchPlannerMappingsCount

      public static int getBatchPlannerMappingsCount()
      Returns the number of batch planner mappings.
      Returns:
      the number of batch planner mappings
    • 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
    • updateBatchPlannerMapping

      public static BatchPlannerMapping updateBatchPlannerMapping(BatchPlannerMapping batchPlannerMapping)
      Updates the batch planner mapping in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect BatchPlannerMappingLocalServiceImpl 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:
      batchPlannerMapping - the batch planner mapping
      Returns:
      the batch planner mapping that was updated
    • updateBatchPlannerMapping

      public static BatchPlannerMapping updateBatchPlannerMapping(long batchPlannerMappingId, String externalFieldName, String externalFieldType, String script) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static BatchPlannerMappingLocalService getService()