public class BatchPlannerPlanLocalServiceUtil
extends java.lang.Object
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.BatchPlannerPlanLocalService
Constructor and Description |
---|
BatchPlannerPlanLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static BatchPlannerPlan |
addBatchPlannerPlan(BatchPlannerPlan batchPlannerPlan)
Adds the batch planner plan to the database.
|
static BatchPlannerPlan |
addBatchPlannerPlan(long userId,
boolean export,
java.lang.String externalType,
java.lang.String externalURL,
java.lang.String internalClassName,
java.lang.String name,
int size,
java.lang.String taskItemDelegateName,
boolean template) |
static BatchPlannerPlan |
createBatchPlannerPlan(long batchPlannerPlanId)
Creates a new batch planner plan with the primary key.
|
static com.liferay.portal.kernel.model.PersistedModel |
createPersistedModel(java.io.Serializable primaryKeyObj) |
static void |
deactivateBatchPlannerPlan(java.lang.String batchEngineTaskERC) |
static BatchPlannerPlan |
deleteBatchPlannerPlan(BatchPlannerPlan batchPlannerPlan)
Deletes the batch planner plan from the database.
|
static BatchPlannerPlan |
deleteBatchPlannerPlan(long batchPlannerPlanId)
Deletes the batch planner plan with the primary key from the database.
|
static com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
static <T> T |
dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
static int |
dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
static com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
static <T> java.util.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.
|
static <T> java.util.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.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
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.
|
static BatchPlannerPlan |
fetchBatchPlannerPlan(long batchPlannerPlanId) |
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
static BatchPlannerPlan |
getBatchPlannerPlan(long batchPlannerPlanId)
Returns the batch planner plan with the primary key.
|
static java.util.List<BatchPlannerPlan> |
getBatchPlannerPlans(int start,
int end)
Returns a range of all the batch planner plans.
|
static int |
getBatchPlannerPlansCount()
Returns the number of batch planner plans.
|
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static BatchPlannerPlanLocalService |
getService() |
static void |
setService(BatchPlannerPlanLocalService service) |
static BatchPlannerPlan |
updateBatchPlannerPlan(BatchPlannerPlan batchPlannerPlan)
Updates the batch planner plan in the database or adds it if it does not yet exist.
|
static BatchPlannerPlan |
updateBatchPlannerPlan(long batchPlannerPlanId,
java.lang.String externalType,
java.lang.String internalClassName,
java.lang.String name) |
static BatchPlannerPlan |
updateStatus(long batchPlannerPlanId,
int status) |
public static BatchPlannerPlan addBatchPlannerPlan(BatchPlannerPlan batchPlannerPlan)
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.
batchPlannerPlan
- the batch planner planpublic static BatchPlannerPlan addBatchPlannerPlan(long userId, boolean export, java.lang.String externalType, java.lang.String externalURL, java.lang.String internalClassName, java.lang.String name, int size, java.lang.String taskItemDelegateName, boolean template) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static BatchPlannerPlan createBatchPlannerPlan(long batchPlannerPlanId)
batchPlannerPlanId
- the primary key for the new batch planner planpublic static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void deactivateBatchPlannerPlan(java.lang.String batchEngineTaskERC)
public static BatchPlannerPlan deleteBatchPlannerPlan(BatchPlannerPlan batchPlannerPlan) throws com.liferay.portal.kernel.exception.PortalException
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.
batchPlannerPlan
- the batch planner plancom.liferay.portal.kernel.exception.PortalException
public static BatchPlannerPlan deleteBatchPlannerPlan(long batchPlannerPlanId) throws com.liferay.portal.kernel.exception.PortalException
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.
batchPlannerPlanId
- the primary key of the batch planner plancom.liferay.portal.kernel.exception.PortalException
- if a batch planner plan with the primary key could not be foundpublic static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
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
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
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
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static BatchPlannerPlan fetchBatchPlannerPlan(long batchPlannerPlanId)
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static BatchPlannerPlan getBatchPlannerPlan(long batchPlannerPlanId) throws com.liferay.portal.kernel.exception.PortalException
batchPlannerPlanId
- the primary key of the batch planner plancom.liferay.portal.kernel.exception.PortalException
- if a batch planner plan with the primary key could not be foundpublic static java.util.List<BatchPlannerPlan> getBatchPlannerPlans(int start, int end)
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
.
start
- the lower bound of the range of batch planner plansend
- the upper bound of the range of batch planner plans (not inclusive)public static int getBatchPlannerPlansCount()
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static java.lang.String getOSGiServiceIdentifier()
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static BatchPlannerPlan updateBatchPlannerPlan(BatchPlannerPlan batchPlannerPlan)
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.
batchPlannerPlan
- the batch planner planpublic static BatchPlannerPlan updateBatchPlannerPlan(long batchPlannerPlanId, java.lang.String externalType, java.lang.String internalClassName, java.lang.String name) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static BatchPlannerPlan updateStatus(long batchPlannerPlanId, int status) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static BatchPlannerPlanLocalService getService()
public static void setService(BatchPlannerPlanLocalService service)