com.liferay.dispatch.service

Interface DispatchLogLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

DispatchLogLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface DispatchLogLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

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

DispatchLogLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
DispatchLog	addDispatchLog(DispatchLog dispatchLog) Adds the dispatch log to the database.
DispatchLog	addDispatchLog(long userId, long dispatchTriggerId, java.util.Date endDate, java.lang.String error, java.lang.String output, java.util.Date startDate, DispatchTaskStatus dispatchTaskStatus)
DispatchLog	createDispatchLog(long dispatchLogId) Creates a new dispatch log with the primary key.
com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
DispatchLog	deleteDispatchLog(DispatchLog dispatchLog) Deletes the dispatch log from the database.
DispatchLog	deleteDispatchLog(long dispatchLogId) Deletes the dispatch log with the primary key from the database.
void	deleteDispatchLogs(long dispatchTriggerId)
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
<T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<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.
<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.
<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.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
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.
DispatchLog	fetchDispatchLog(long dispatchLogId)
DispatchLog	fetchLatestDispatchLog(long dispatchTriggerId)
DispatchLog	fetchLatestDispatchLog(long dispatchTriggerId, DispatchTaskStatus dispatchTaskStatus)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
DispatchLog	getDispatchLog(long dispatchLogId) Returns the dispatch log with the primary key.
java.util.List<DispatchLog>	getDispatchLogs(int start, int end) Returns a range of all the dispatch logs.
java.util.List<DispatchLog>	getDispatchLogs(long dispatchTriggerId, int start, int end)
java.util.List<DispatchLog>	getDispatchLogs(long dispatchTriggerId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DispatchLog> orderByComparator)
int	getDispatchLogsCount() Returns the number of dispatch logs.
int	getDispatchLogsCount(long dispatchTriggerId)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
DispatchLog	updateDispatchLog(DispatchLog dispatchLog) Updates the dispatch log in the database or adds it if it does not yet exist.
DispatchLog	updateDispatchLog(long dispatchLogId, java.util.Date endDate, java.lang.String error, java.lang.String output, DispatchTaskStatus dispatchTaskStatus)

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addDispatchLog

@Indexable(type=REINDEX)
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

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

@Transactional(enabled=false)
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

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

Specified by:

createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteDispatchLog

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

void deleteDispatchLogs(long dispatchTriggerId)

deletePersistedModel

com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dslQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DispatchLog fetchDispatchLog(long dispatchLogId)

fetchLatestDispatchLog

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DispatchLog fetchLatestDispatchLog(long dispatchTriggerId)

fetchLatestDispatchLog

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DispatchLog fetchLatestDispatchLog(long dispatchTriggerId,
                                                                                                      DispatchTaskStatus dispatchTaskStatus)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getDispatchLog

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DispatchLog> getDispatchLogs(long dispatchTriggerId,
                                                                                                               int start,
                                                                                                               int end)

getDispatchLogs

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DispatchLog> getDispatchLogs(long dispatchTriggerId,
                                                                                                               int start,
                                                                                                               int end,
                                                                                                               com.liferay.portal.kernel.util.OrderByComparator<DispatchLog> orderByComparator)

getDispatchLogsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDispatchLogsCount()

Returns the number of dispatch logs.

Returns:

the number of dispatch logs

getDispatchLogsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDispatchLogsCount(long dispatchTriggerId)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

updateDispatchLog

@Indexable(type=REINDEX)
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

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