com.liferay.document.library.kernel.service

Interface DLSyncEventLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

DLSyncEventLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DLSyncEventLocalService
extends BaseLocalService, PersistedModelLocalService

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

Author:

Brian Wing Shun Chan

See Also:

DLSyncEventLocalServiceUtil, DLSyncEventLocalServiceBaseImpl, DLSyncEventLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
DLSyncEvent	addDLSyncEvent(DLSyncEvent dlSyncEvent) Adds the dl sync event to the database.
DLSyncEvent	addDLSyncEvent(String event, String type, long typePK)
DLSyncEvent	createDLSyncEvent(long syncEventId) Creates a new dl sync event with the primary key.
DLSyncEvent	deleteDLSyncEvent(DLSyncEvent dlSyncEvent) Deletes the dl sync event from the database.
DLSyncEvent	deleteDLSyncEvent(long syncEventId) Deletes the dl sync event with the primary key from the database.
void	deleteDLSyncEvents()
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
DLSyncEvent	fetchDLSyncEvent(long syncEventId)
ActionableDynamicQuery	getActionableDynamicQuery()
DLSyncEvent	getDLSyncEvent(long syncEventId) Returns the dl sync event with the primary key.
List<DLSyncEvent>	getDLSyncEvents(int start, int end) Returns a range of all the dl sync events.
List<DLSyncEvent>	getDLSyncEvents(long modifiedTime)
int	getDLSyncEventsCount() Returns the number of dl sync events.
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
List<DLSyncEvent>	getLatestDLSyncEvents()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
DLSyncEvent	updateDLSyncEvent(DLSyncEvent dlSyncEvent) Updates the dl sync event in the database or adds it if it does not yet exist.

Method Detail

addDLSyncEvent

@Indexable(type=REINDEX)
DLSyncEvent addDLSyncEvent(DLSyncEvent dlSyncEvent)

Adds the dl sync event to the database. Also notifies the appropriate model listeners.

Parameters:

dlSyncEvent - the dl sync event

Returns:

the dl sync event that was added

addDLSyncEvent

DLSyncEvent addDLSyncEvent(String event,
                           String type,
                           long typePK)

createDLSyncEvent

@Transactional(enabled=false)
DLSyncEvent createDLSyncEvent(long syncEventId)

Creates a new dl sync event with the primary key. Does not add the dl sync event to the database.

Parameters:

syncEventId - the primary key for the new dl sync event

Returns:

the new dl sync event

deleteDLSyncEvent

@Indexable(type=DELETE)
DLSyncEvent deleteDLSyncEvent(DLSyncEvent dlSyncEvent)

Deletes the dl sync event from the database. Also notifies the appropriate model listeners.

Parameters:

dlSyncEvent - the dl sync event

Returns:

the dl sync event that was removed

deleteDLSyncEvent

@Indexable(type=DELETE)
DLSyncEvent deleteDLSyncEvent(long syncEventId)
                                               throws PortalException

Deletes the dl sync event with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

syncEventId - the primary key of the dl sync event

Returns:

the dl sync event that was removed

Throws:

PortalException - if a dl sync event with the primary key could not be found

deleteDLSyncEvents

void deleteDLSyncEvents()

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DLSyncEventModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end,
                                                                                            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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DLSyncEventModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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(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(DynamicQuery dynamicQuery,
                                                                                          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

fetchDLSyncEvent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLSyncEvent fetchDLSyncEvent(long syncEventId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getDLSyncEvent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLSyncEvent getDLSyncEvent(long syncEventId)
                                                                                       throws PortalException

Returns the dl sync event with the primary key.

Parameters:

syncEventId - the primary key of the dl sync event

Returns:

the dl sync event

Throws:

PortalException - if a dl sync event with the primary key could not be found

getDLSyncEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLSyncEvent> getDLSyncEvents(int start,
                                                                                                     int end)

Returns a range of all the dl sync events.

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DLSyncEventModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of dl sync events

end - the upper bound of the range of dl sync events (not inclusive)

Returns:

the range of dl sync events

getDLSyncEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLSyncEvent> getDLSyncEvents(long modifiedTime)

getDLSyncEventsCount

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

Returns the number of dl sync events.

Returns:

the number of dl sync events

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLatestDLSyncEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLSyncEvent> getLatestDLSyncEvents()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

updateDLSyncEvent

@Indexable(type=REINDEX)
DLSyncEvent updateDLSyncEvent(DLSyncEvent dlSyncEvent)

Updates the dl sync event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

dlSyncEvent - the dl sync event

Returns:

the dl sync event that was updated