com.liferay.document.library.kernel.service

Class DLSyncEventLocalServiceUtil

Object

com.liferay.document.library.kernel.service.DLSyncEventLocalServiceUtil

@ProviderType
public class DLSyncEventLocalServiceUtil
extends Object

Provides the local service utility for DLSyncEvent. This utility wraps DLSyncEventLocalServiceImpl and is the primary 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.

Author:

Brian Wing Shun Chan

See Also:

DLSyncEventLocalService, DLSyncEventLocalServiceBaseImpl, DLSyncEventLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
DLSyncEventLocalServiceUtil()

Method Summary

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

Methods inherited from class Object

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

Constructor Detail

DLSyncEventLocalServiceUtil

public DLSyncEventLocalServiceUtil()

Method Detail

addDLSyncEvent

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

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

createDLSyncEvent

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

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

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

public static void deleteDLSyncEvents()

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

public static DLSyncEvent fetchDLSyncEvent(long syncEventId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getDLSyncEvent

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

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

public static List<DLSyncEvent> getDLSyncEvents(long modifiedTime)

getDLSyncEventsCount

public static int getDLSyncEventsCount()

Returns the number of dl sync events.

Returns:

the number of dl sync events

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLatestDLSyncEvents

public static List<DLSyncEvent> getLatestDLSyncEvents()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

updateDLSyncEvent

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

getService

public static DLSyncEventLocalService getService()