Liferay 6.0.5

com.liferay.portal.service
Interface UserTrackerLocalService

All Known Implementing Classes:
UserTrackerLocalServiceBaseImpl, UserTrackerLocalServiceImpl, UserTrackerLocalServiceWrapper

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

The interface for the user tracker local service.

Never modify or reference this interface directly. Always use UserTrackerLocalServiceUtil to access the user tracker local service. Add custom service methods to UserTrackerLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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:
UserTrackerLocalServiceUtil, UserTrackerLocalServiceBaseImpl, UserTrackerLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 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.
 void deleteUserTracker(long userTrackerId)
          Deletes the user tracker with the primary key from the database.
 void deleteUserTracker(UserTracker userTracker)
          Deletes the user tracker from the database.
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Counts the number of rows that match the dynamic query.
 UserTracker getUserTracker(long userTrackerId)
          Gets the user tracker with the primary key.
 List<UserTracker> getUserTrackers(int start, int end)
          Gets a range of all the user trackers.
 List<UserTracker> getUserTrackers(long companyId, int start, int end)
           
 int getUserTrackersCount()
          Gets the number of user trackers.
 UserTracker updateUserTracker(UserTracker userTracker)
          Updates the user tracker in the database.
 UserTracker updateUserTracker(UserTracker userTracker, boolean merge)
          Updates the user tracker in the database.
 

Method Detail

addUserTracker

UserTracker addUserTracker(UserTracker userTracker)
                           throws SystemException
Adds the user tracker to the database. Also notifies the appropriate model listeners.

Parameters:
userTracker - the user tracker to add
Returns:
the user tracker that was added
Throws:
SystemException - if a system exception occurred

createUserTracker

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

void 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 to delete
Throws:
PortalException - if a user tracker with the primary key could not be found
SystemException - if a system exception occurred

deleteUserTracker

void deleteUserTracker(UserTracker userTracker)
                       throws SystemException
Deletes the user tracker from the database. Also notifies the appropriate model listeners.

Parameters:
userTracker - the user tracker to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Counts the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getUserTracker

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserTracker getUserTracker(long userTrackerId)
                           throws PortalException,
                                  SystemException
Gets the user tracker with the primary key.

Parameters:
userTrackerId - the primary key of the user tracker to get
Returns:
the user tracker
Throws:
PortalException - if a user tracker with the primary key could not be found
SystemException - if a system exception occurred

getUserTrackers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserTracker> getUserTrackers(int start,
                                                                           int end)
                                  throws SystemException
Gets 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 to return
end - the upper bound of the range of user trackers to return (not inclusive)
Returns:
the range of user trackers
Throws:
SystemException - if a system exception occurred

getUserTrackersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserTrackersCount()
                         throws SystemException
Gets the number of user trackers.

Returns:
the number of user trackers
Throws:
SystemException - if a system exception occurred

updateUserTracker

UserTracker updateUserTracker(UserTracker userTracker)
                              throws SystemException
Updates the user tracker in the database. Also notifies the appropriate model listeners.

Parameters:
userTracker - the user tracker to update
Returns:
the user tracker that was updated
Throws:
SystemException - if a system exception occurred

updateUserTracker

UserTracker updateUserTracker(UserTracker userTracker,
                              boolean merge)
                              throws SystemException
Updates the user tracker in the database. Also notifies the appropriate model listeners.

Parameters:
userTracker - the user tracker to update
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

addUserTracker

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

getUserTrackers

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

Liferay 6.0.5