com.liferay.portal.kernel.service

Interface UserTrackerLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

UserTrackerLocalServiceWrapper

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

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

UserTrackerLocalServiceUtil, UserTrackerLocalServiceBaseImpl, UserTrackerLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
UserTracker	addUserTracker(long companyId, long userId, Date modifiedDate, String sessionId, String remoteAddr, String remoteHost, String userAgent, List<UserTrackerPath> userTrackerPaths)
UserTracker	addUserTracker(UserTracker userTracker) Adds the user tracker to the database.
UserTracker	createUserTracker(long userTrackerId) Creates a new user tracker with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
UserTracker	deleteUserTracker(long userTrackerId) Deletes the user tracker with the primary key from the database.
UserTracker	deleteUserTracker(UserTracker userTracker) Deletes the user tracker from the database.
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.
UserTracker	fetchUserTracker(long userTrackerId)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
UserTracker	getUserTracker(long userTrackerId) Returns the user tracker with the primary key.
List<UserTracker>	getUserTrackers(int start, int end) Returns a range of all the user trackers.
List<UserTracker>	getUserTrackers(long companyId, int start, int end)
int	getUserTrackersCount() Returns the number of user trackers.
UserTracker	updateUserTracker(UserTracker userTracker) Updates the user tracker in the database or adds it if it does not yet exist.

Method Detail

addUserTracker

UserTracker addUserTracker(long companyId,
                           long userId,
                           Date modifiedDate,
                           String sessionId,
                           String remoteAddr,
                           String remoteHost,
                           String userAgent,
                           List<UserTrackerPath> userTrackerPaths)

addUserTracker

@Indexable(type=REINDEX)
UserTracker addUserTracker(UserTracker userTracker)

Adds the user tracker to the database. Also notifies the appropriate model listeners.

Parameters:

userTracker - the user tracker

Returns:

the user tracker that was added

createUserTracker

@Transactional(enabled=false)
UserTracker createUserTracker(long userTrackerId)

Creates a new user tracker with the primary key. Does not add the user tracker to the database.

Parameters:

userTrackerId - the primary key for the new user tracker

Returns:

the new user tracker

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteUserTracker

@Indexable(type=DELETE)
UserTracker deleteUserTracker(long userTrackerId)
                                               throws PortalException

Deletes the user tracker with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

userTrackerId - the primary key of the user tracker

Returns:

the user tracker that was removed

Throws:

PortalException - if a user tracker with the primary key could not be found

deleteUserTracker

@Indexable(type=DELETE)
UserTracker deleteUserTracker(UserTracker userTracker)

Deletes the user tracker from the database. Also notifies the appropriate model listeners.

Parameters:

userTracker - the user tracker

Returns:

the user tracker that was removed

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

fetchUserTracker

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserTracker fetchUserTracker(long userTrackerId)

getActionableDynamicQuery

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

getIndexableActionableDynamicQuery

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

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

getUserTracker

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserTracker getUserTracker(long userTrackerId)
                                                                                       throws PortalException

Returns the user tracker with the primary key.

Parameters:

userTrackerId - the primary key of the user tracker

Returns:

the user tracker

Throws:

PortalException - if a user tracker with the primary key could not be found

getUserTrackers

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

Returns a range of all the user trackers.

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 UserTrackerModelImpl. 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 user trackers

end - the upper bound of the range of user trackers (not inclusive)

Returns:

the range of user trackers

getUserTrackers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserTracker> getUserTrackers(long companyId,
                                                                                                     int start,
                                                                                                     int end)

getUserTrackersCount

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

Returns the number of user trackers.

Returns:

the number of user trackers

updateUserTracker

@Indexable(type=REINDEX)
UserTracker updateUserTracker(UserTracker userTracker)

Updates the user tracker in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

userTracker - the user tracker

Returns:

the user tracker that was updated