Class UserTrackerLocalServiceUtil

Object
com.liferay.portal.kernel.service.UserTrackerLocalServiceUtil

public class UserTrackerLocalServiceUtil extends Object
Provides the local service utility for UserTracker. This utility wraps com.liferay.portal.service.impl.UserTrackerLocalServiceImpl and is an 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:
{$generated.description}
  • Constructor Details

    • UserTrackerLocalServiceUtil

      public UserTrackerLocalServiceUtil()
  • Method Details

    • addUserTracker

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

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

      Important: Inspect UserTrackerLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      userTracker - the user tracker
      Returns:
      the user tracker that was added
    • createPersistedModel

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • 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
    • deletePersistedModel

      public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Throws:
      PortalException
    • deleteUserTracker

      public static UserTracker deleteUserTracker(long userTrackerId) throws PortalException
      Deletes the user tracker with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect UserTrackerLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      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

      public static UserTracker deleteUserTracker(UserTracker userTracker)
      Deletes the user tracker from the database. Also notifies the appropriate model listeners.

      Important: Inspect UserTrackerLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      userTracker - the user tracker
      Returns:
      the user tracker that was removed
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.UserTrackerModelImpl.

      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.UserTrackerModelImpl.

      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
    • fetchUserTracker

      public static UserTracker fetchUserTracker(long userTrackerId)
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • 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
    • getUserTracker

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

      public static 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.UserTrackerModelImpl.

      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

      public static List<UserTracker> getUserTrackers(long companyId, int start, int end)
    • getUserTrackersCount

      public static int getUserTrackersCount()
      Returns the number of user trackers.
      Returns:
      the number of user trackers
    • updateUserTracker

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

      Important: Inspect UserTrackerLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      userTracker - the user tracker
      Returns:
      the user tracker that was updated
    • getService

      public static UserTrackerLocalService getService()
    • setService

      public static void setService(UserTrackerLocalService service)