Class DispatchLogLocalServiceUtil
com.liferay.dispatch.service.impl.DispatchLogLocalServiceImpl 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 DispatchLogaddDispatchLog(long userId, long dispatchTriggerId, Date endDate, String error, String output, Date startDate, DispatchTaskStatus dispatchTaskStatus) static DispatchLogaddDispatchLog(DispatchLog dispatchLog) Adds the dispatch log to the database.static DispatchLogcreateDispatchLog(long dispatchLogId) Creates a new dispatch log with the primary key.static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static DispatchLogdeleteDispatchLog(long dispatchLogId) Deletes the dispatch log with the primary key from the database.static DispatchLogdeleteDispatchLog(DispatchLog dispatchLog) Deletes the dispatch log from the database.static voiddeleteDispatchLogs(long dispatchTriggerId) 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 DispatchLogfetchDispatchLog(long dispatchLogId) static DispatchLogfetchLatestDispatchLog(long dispatchTriggerId) static DispatchLogfetchLatestDispatchLog(long dispatchTriggerId, DispatchTaskStatus dispatchTaskStatus) static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic DispatchLoggetDispatchLog(long dispatchLogId) Returns the dispatch log with the primary key.static List<DispatchLog> getDispatchLogs(int start, int end) Returns a range of all the dispatch logs.static List<DispatchLog> getDispatchLogs(long dispatchTriggerId, int start, int end) static List<DispatchLog> getDispatchLogs(long dispatchTriggerId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DispatchLog> orderByComparator) static intReturns the number of dispatch logs.static intgetDispatchLogsCount(long dispatchTriggerId) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerystatic StringReturns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) static DispatchLogLocalServicestatic DispatchLogupdateDispatchLog(long dispatchLogId, Date endDate, String error, String output, DispatchTaskStatus dispatchTaskStatus) static DispatchLogupdateDispatchLog(DispatchLog dispatchLog) Updates the dispatch log in the database or adds it if it does not yet exist.
-
Constructor Details
-
DispatchLogLocalServiceUtil
public DispatchLogLocalServiceUtil()
-
-
Method Details
-
addDispatchLog
Adds the dispatch log to the database. Also notifies the appropriate model listeners.Important: Inspect DispatchLogLocalServiceImpl 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:
dispatchLog- the dispatch log- Returns:
- the dispatch log that was added
-
addDispatchLog
public static DispatchLog addDispatchLog(long userId, long dispatchTriggerId, Date endDate, String error, String output, Date startDate, DispatchTaskStatus dispatchTaskStatus) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createDispatchLog
Creates a new dispatch log with the primary key. Does not add the dispatch log to the database.- Parameters:
dispatchLogId- the primary key for the new dispatch log- Returns:
- the new dispatch log
-
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
-
deleteDispatchLog
Deletes the dispatch log from the database. Also notifies the appropriate model listeners.Important: Inspect DispatchLogLocalServiceImpl 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:
dispatchLog- the dispatch log- Returns:
- the dispatch log that was removed
-
deleteDispatchLog
public static DispatchLog deleteDispatchLog(long dispatchLogId) throws com.liferay.portal.kernel.exception.PortalException Deletes the dispatch log with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect DispatchLogLocalServiceImpl 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:
dispatchLogId- the primary key of the dispatch log- Returns:
- the dispatch log that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a dispatch log with the primary key could not be found
-
deleteDispatchLogs
public static void deleteDispatchLogs(long dispatchTriggerId) -
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.dispatch.model.impl.DispatchLogModelImpl.- 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.dispatch.model.impl.DispatchLogModelImpl.- 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
-
fetchDispatchLog
-
fetchLatestDispatchLog
-
fetchLatestDispatchLog
public static DispatchLog fetchLatestDispatchLog(long dispatchTriggerId, DispatchTaskStatus dispatchTaskStatus) -
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getDispatchLog
public static DispatchLog getDispatchLog(long dispatchLogId) throws com.liferay.portal.kernel.exception.PortalException Returns the dispatch log with the primary key.- Parameters:
dispatchLogId- the primary key of the dispatch log- Returns:
- the dispatch log
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a dispatch log with the primary key could not be found
-
getDispatchLogs
Returns a range of all the dispatch logs.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.dispatch.model.impl.DispatchLogModelImpl.- Parameters:
start- the lower bound of the range of dispatch logsend- the upper bound of the range of dispatch logs (not inclusive)- Returns:
- the range of dispatch logs
-
getDispatchLogs
-
getDispatchLogs
public static List<DispatchLog> getDispatchLogs(long dispatchTriggerId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DispatchLog> orderByComparator) -
getDispatchLogsCount
public static int getDispatchLogsCount()Returns the number of dispatch logs.- Returns:
- the number of dispatch logs
-
getDispatchLogsCount
public static int getDispatchLogsCount(long dispatchTriggerId) -
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
-
updateDispatchLog
Updates the dispatch log in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect DispatchLogLocalServiceImpl 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:
dispatchLog- the dispatch log- Returns:
- the dispatch log that was updated
-
updateDispatchLog
public static DispatchLog updateDispatchLog(long dispatchLogId, Date endDate, String error, String output, DispatchTaskStatus dispatchTaskStatus) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-