com.liferay.dispatch.service

Class DispatchLogLocalServiceUtil

java.lang.Object

com.liferay.dispatch.service.DispatchLogLocalServiceUtil

public class DispatchLogLocalServiceUtil
extends java.lang.Object

Provides the local service utility for DispatchLog. This utility wraps 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:

DispatchLogLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
DispatchLogLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static DispatchLog	addDispatchLog(DispatchLog dispatchLog) Adds the dispatch log to the database.
static DispatchLog	addDispatchLog(long userId, long dispatchTriggerId, java.util.Date endDate, java.lang.String error, java.lang.String output, java.util.Date startDate, DispatchTaskStatus dispatchTaskStatus)
static DispatchLog	createDispatchLog(long dispatchLogId) Creates a new dispatch log with the primary key.
static com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static DispatchLog	deleteDispatchLog(DispatchLog dispatchLog) Deletes the dispatch log from the database.
static DispatchLog	deleteDispatchLog(long dispatchLogId) Deletes the dispatch log with the primary key from the database.
static void	deleteDispatchLogs(long dispatchTriggerId)
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 DispatchLog	fetchDispatchLog(long dispatchLogId)
static DispatchLog	fetchLatestDispatchLog(long dispatchTriggerId)
static DispatchLog	fetchLatestDispatchLog(long dispatchTriggerId, DispatchTaskStatus dispatchTaskStatus)
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static DispatchLog	getDispatchLog(long dispatchLogId) Returns the dispatch log with the primary key.
static java.util.List<DispatchLog>	getDispatchLogs(int start, int end) Returns a range of all the dispatch logs.
static java.util.List<DispatchLog>	getDispatchLogs(long dispatchTriggerId, int start, int end)
static java.util.List<DispatchLog>	getDispatchLogs(long dispatchTriggerId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DispatchLog> orderByComparator)
static int	getDispatchLogsCount() Returns the number of dispatch logs.
static int	getDispatchLogsCount(long dispatchTriggerId)
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 DispatchLogLocalService	getService()
static DispatchLog	updateDispatchLog(DispatchLog dispatchLog) Updates the dispatch log in the database or adds it if it does not yet exist.
static DispatchLog	updateDispatchLog(long dispatchLogId, java.util.Date endDate, java.lang.String error, java.lang.String output, DispatchTaskStatus dispatchTaskStatus)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DispatchLogLocalServiceUtil

public DispatchLogLocalServiceUtil()

Method Detail

addDispatchLog

public static DispatchLog addDispatchLog(DispatchLog dispatchLog)

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,
                                         java.util.Date endDate,
                                         java.lang.String error,
                                         java.lang.String output,
                                         java.util.Date startDate,
                                         DispatchTaskStatus dispatchTaskStatus)
                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createDispatchLog

public static DispatchLog createDispatchLog(long dispatchLogId)

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(java.io.Serializable primaryKeyObj)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteDispatchLog

public static DispatchLog deleteDispatchLog(DispatchLog dispatchLog)

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

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

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

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.dispatch.model.impl.DispatchLogModelImpl.

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

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.dispatch.model.impl.DispatchLogModelImpl.

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

fetchDispatchLog

public static DispatchLog fetchDispatchLog(long dispatchLogId)

fetchLatestDispatchLog

public static DispatchLog fetchLatestDispatchLog(long dispatchTriggerId)

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

public static java.util.List<DispatchLog> getDispatchLogs(int start,
                                                          int end)

Returns a range of all the dispatch logs.

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.dispatch.model.impl.DispatchLogModelImpl.

Parameters:

start - the lower bound of the range of dispatch logs

end - the upper bound of the range of dispatch logs (not inclusive)

Returns:

the range of dispatch logs

getDispatchLogs

public static java.util.List<DispatchLog> getDispatchLogs(long dispatchTriggerId,
                                                          int start,
                                                          int end)

getDispatchLogs

public static java.util.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

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateDispatchLog

public static DispatchLog updateDispatchLog(DispatchLog dispatchLog)

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,
                                            java.util.Date endDate,
                                            java.lang.String error,
                                            java.lang.String output,
                                            DispatchTaskStatus dispatchTaskStatus)
                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getService

public static DispatchLogLocalService getService()