Class BatchPlannerPolicyLocalServiceUtil
com.liferay.batch.planner.service.impl.BatchPlannerPolicyLocalServiceImpl 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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic BatchPlannerPolicyaddBatchPlannerPolicy(long userId, long batchPlannerPlanId, String name, String value) static BatchPlannerPolicyaddBatchPlannerPolicy(BatchPlannerPolicy batchPlannerPolicy) Adds the batch planner policy to the database.static BatchPlannerPolicycreateBatchPlannerPolicy(long batchPlannerPolicyId) Creates a new batch planner policy with the primary key.static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static BatchPlannerPolicydeleteBatchPlannerPolicy(long batchPlannerPolicyId) Deletes the batch planner policy with the primary key from the database.static BatchPlannerPolicydeleteBatchPlannerPolicy(long batchPlannerPlanId, String name) static BatchPlannerPolicydeleteBatchPlannerPolicy(BatchPlannerPolicy batchPlannerPolicy) Deletes the batch planner policy from the database.static com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuerystatic <T> 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> 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> 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 longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(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 BatchPlannerPolicyfetchBatchPlannerPolicy(long batchPlannerPolicyId) static BatchPlannerPolicyfetchBatchPlannerPolicy(long batchPlannerPlanId, String name) static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic List<BatchPlannerPolicy>getBatchPlannerPolicies(int start, int end) Returns a range of all the batch planner policies.static List<BatchPlannerPolicy>getBatchPlannerPolicies(long batchPlannerPlanId) static intReturns the number of batch planner policies.static BatchPlannerPolicygetBatchPlannerPolicy(long batchPlannerPolicyId) Returns the batch planner policy with the primary key.static BatchPlannerPolicygetBatchPlannerPolicy(long batchPlannerPlanId, String name) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerystatic StringReturns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) static booleanhasBatchPlannerPolicy(long batchPlannerPlanId, String name) static BatchPlannerPolicyupdateBatchPlannerPolicy(long batchPlannerPlanId, String name, String value) static BatchPlannerPolicyupdateBatchPlannerPolicy(BatchPlannerPolicy batchPlannerPolicy) Updates the batch planner policy in the database or adds it if it does not yet exist.
-
Constructor Details
-
BatchPlannerPolicyLocalServiceUtil
public BatchPlannerPolicyLocalServiceUtil()
-
-
Method Details
-
addBatchPlannerPolicy
Adds the batch planner policy to the database. Also notifies the appropriate model listeners.Important: Inspect BatchPlannerPolicyLocalServiceImpl 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:
batchPlannerPolicy- the batch planner policy- Returns:
- the batch planner policy that was added
-
addBatchPlannerPolicy
public static BatchPlannerPolicy addBatchPlannerPolicy(long userId, long batchPlannerPlanId, String name, String value) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createBatchPlannerPolicy
Creates a new batch planner policy with the primary key. Does not add the batch planner policy to the database.- Parameters:
batchPlannerPolicyId- the primary key for the new batch planner policy- Returns:
- the new batch planner policy
-
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
-
deleteBatchPlannerPolicy
Deletes the batch planner policy from the database. Also notifies the appropriate model listeners.Important: Inspect BatchPlannerPolicyLocalServiceImpl 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:
batchPlannerPolicy- the batch planner policy- Returns:
- the batch planner policy that was removed
-
deleteBatchPlannerPolicy
public static BatchPlannerPolicy deleteBatchPlannerPolicy(long batchPlannerPolicyId) throws com.liferay.portal.kernel.exception.PortalException Deletes the batch planner policy with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect BatchPlannerPolicyLocalServiceImpl 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:
batchPlannerPolicyId- the primary key of the batch planner policy- Returns:
- the batch planner policy that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a batch planner policy with the primary key could not be found
-
deleteBatchPlannerPolicy
public static BatchPlannerPolicy deleteBatchPlannerPolicy(long batchPlannerPlanId, String name) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
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
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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.batch.planner.model.impl.BatchPlannerPolicyModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.batch.planner.model.impl.BatchPlannerPolicyModelImpl.- Parameters:
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 (optionallynull)- 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 queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchBatchPlannerPolicy
-
fetchBatchPlannerPolicy
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getBatchPlannerPolicies
Returns a range of all the batch planner policies.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.batch.planner.model.impl.BatchPlannerPolicyModelImpl.- Parameters:
start- the lower bound of the range of batch planner policiesend- the upper bound of the range of batch planner policies (not inclusive)- Returns:
- the range of batch planner policies
-
getBatchPlannerPolicies
-
getBatchPlannerPoliciesCount
public static int getBatchPlannerPoliciesCount()Returns the number of batch planner policies.- Returns:
- the number of batch planner policies
-
getBatchPlannerPolicy
public static BatchPlannerPolicy getBatchPlannerPolicy(long batchPlannerPolicyId) throws com.liferay.portal.kernel.exception.PortalException Returns the batch planner policy with the primary key.- Parameters:
batchPlannerPolicyId- the primary key of the batch planner policy- Returns:
- the batch planner policy
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a batch planner policy with the primary key could not be found
-
getBatchPlannerPolicy
public static BatchPlannerPolicy getBatchPlannerPolicy(long batchPlannerPlanId, String name) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
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
-
hasBatchPlannerPolicy
-
updateBatchPlannerPolicy
Updates the batch planner policy in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect BatchPlannerPolicyLocalServiceImpl 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:
batchPlannerPolicy- the batch planner policy- Returns:
- the batch planner policy that was updated
-
updateBatchPlannerPolicy
public static BatchPlannerPolicy updateBatchPlannerPolicy(long batchPlannerPlanId, String name, String value) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-