Liferay 6.2.0

com.liferay.portal.service
Interface UserTrackerLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
UserTrackerLocalServiceBaseImpl, UserTrackerLocalServiceImpl, 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.

See Also:
UserTrackerLocalServiceUtil, UserTrackerLocalServiceBaseImpl, UserTrackerLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
abstract  UserTracker addUserTracker(long companyId, long userId, Date modifiedDate, String sessionId, String remoteAddr, String remoteHost, String userAgent, List<UserTrackerPath> userTrackerPaths)
           
abstract  UserTracker addUserTracker(UserTracker userTracker)
          Adds the user tracker to the database.
abstract  UserTracker createUserTracker(long userTrackerId)
          Creates a new user tracker with the primary key.
abstract  UserTracker deleteUserTracker(long userTrackerId)
          Deletes the user tracker with the primary key from the database.
abstract  UserTracker deleteUserTracker(UserTracker userTracker)
          Deletes the user tracker from the database.
abstract  DynamicQuery dynamicQuery()
           
abstract  List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
abstract  List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
abstract  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.
abstract  long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
abstract  long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
abstract  UserTracker fetchUserTracker(long userTrackerId)
           
abstract  String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
abstract  PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
abstract  UserTracker getUserTracker(long userTrackerId)
          Returns the user tracker with the primary key.
abstract  List<UserTracker> getUserTrackers(int start, int end)
          Returns a range of all the user trackers.
abstract  List<UserTracker> getUserTrackers(long companyId, int start, int end)
           
abstract  int getUserTrackersCount()
          Returns the number of user trackers.
abstract  void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
abstract  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(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

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

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

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

DynamicQuery dynamicQuery()

dynamicQuery

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

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. 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
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. 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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

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

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

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

fetchUserTracker

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserTracker fetchUserTracker(long userTrackerId)
                             throws SystemException
Throws:
SystemException

getUserTracker

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getUserTrackers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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. 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
Throws:
SystemException - if a system exception occurred

getUserTrackersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserTrackersCount()
                         throws SystemException
Returns 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 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

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

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