com.liferay.portal.service
Class UserTrackerLocalServiceUtil

java.lang.Object
  com.liferay.portal.service.UserTrackerLocalServiceUtil

public class UserTrackerLocalServiceUtil
extends Object

The utility for the user tracker local service. This utility wraps com.liferay.portal.service.impl.UserTrackerLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

This is a local service. 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:

UserTrackerLocalService, UserTrackerLocalServiceBaseImpl, com.liferay.portal.service.impl.UserTrackerLocalServiceImpl

Constructor Summary

UserTrackerLocalServiceUtil()

Method Summary

static UserTracker	addUserTracker(long companyId, long userId, Date modifiedDate, String sessionId, String remoteAddr, String remoteHost, String userAgent, List<UserTrackerPath> userTrackerPaths)
static UserTracker	addUserTracker(UserTracker userTracker) Adds the user tracker to the database.
static UserTracker	createUserTracker(long userTrackerId) Creates a new user tracker with the primary key.
static UserTracker	deleteUserTracker(long userTrackerId) Deletes the user tracker with the primary key from the database.
static UserTracker	deleteUserTracker(UserTracker userTracker) Deletes the user tracker from the database.
static DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
static UserTracker	fetchUserTracker(long userTrackerId)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static UserTrackerLocalService	getService()
static UserTracker	getUserTracker(long userTrackerId) Returns the user tracker with the primary key.
static List<UserTracker>	getUserTrackers(int start, int end) Returns a range of all the user trackers.
static List<UserTracker>	getUserTrackers(long companyId, int start, int end)
static int	getUserTrackersCount() Returns the number of user trackers.
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(UserTrackerLocalService service) Deprecated.
static UserTracker	updateUserTracker(UserTracker userTracker) Updates the user tracker in the database or adds it if it does not yet exist.
static UserTracker	updateUserTracker(UserTracker userTracker, boolean merge) Updates the user tracker in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserTrackerLocalServiceUtil

public UserTrackerLocalServiceUtil()

Method Detail

addUserTracker

public static UserTracker addUserTracker(UserTracker userTracker)
                                  throws SystemException

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

Throws:

SystemException - if a system exception occurred

createUserTracker

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

deleteUserTracker

public static UserTracker deleteUserTracker(long userTrackerId)
                                     throws PortalException,
                                            SystemException

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

SystemException - if a system exception occurred

deleteUserTracker

public static UserTracker deleteUserTracker(UserTracker userTracker)
                                     throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchUserTracker

public static UserTracker fetchUserTracker(long userTrackerId)
                                    throws SystemException

Throws:

SystemException

getUserTracker

public static UserTracker getUserTracker(long userTrackerId)
                                  throws PortalException,
                                         SystemException

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

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getUserTrackers

public static List<UserTracker> getUserTrackers(int start,
                                                int end)
                                         throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

getUserTrackersCount

public static int getUserTrackersCount()
                                throws SystemException

Returns the number of user trackers.

Returns:

the number of user trackers

Throws:

SystemException - if a system exception occurred

updateUserTracker

public static UserTracker updateUserTracker(UserTracker userTracker)
                                     throws SystemException

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

Throws:

SystemException - if a system exception occurred

updateUserTracker

public static UserTracker updateUserTracker(UserTracker userTracker,
                                            boolean merge)
                                     throws SystemException

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

merge - whether to merge the user tracker with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the user tracker that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addUserTracker

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

Throws:

SystemException

getUserTrackers

public static List<UserTracker> getUserTrackers(long companyId,
                                                int start,
                                                int end)
                                         throws SystemException

Throws:

SystemException

getService

public static UserTrackerLocalService getService()

setService

public void setService(UserTrackerLocalService service)

Deprecated.