Class UserIdMapperUtil

Object
com.liferay.portal.kernel.service.persistence.UserIdMapperUtil

public class UserIdMapperUtil extends Object
The persistence utility for the user ID mapper service. This utility wraps com.liferay.portal.service.persistence.impl.UserIdMapperPersistenceImpl and provides direct access to the database for CRUD operations. This utility should only be used by the service layer, as it must operate within a transaction. Never access this utility in a JSP, controller, model, or other front-end class.

Caching information and settings can be found in portal.properties

Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • UserIdMapperUtil

      public UserIdMapperUtil()
  • Method Details

    • clearCache

      public static void clearCache()
      See Also:
    • clearCache

      public static void clearCache(UserIdMapper userIdMapper)
      See Also:
    • countWithDynamicQuery

      public static long countWithDynamicQuery(DynamicQuery dynamicQuery)
      See Also:
    • fetchByPrimaryKeys

      public static Map<Serializable,UserIdMapper> fetchByPrimaryKeys(Set<Serializable> primaryKeys)
      See Also:
    • findWithDynamicQuery

      public static List<UserIdMapper> findWithDynamicQuery(DynamicQuery dynamicQuery)
      See Also:
    • findWithDynamicQuery

      public static List<UserIdMapper> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end)
      See Also:
    • findWithDynamicQuery

      public static List<UserIdMapper> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<UserIdMapper> orderByComparator)
      See Also:
    • update

      public static UserIdMapper update(UserIdMapper userIdMapper)
      See Also:
    • update

      public static UserIdMapper update(UserIdMapper userIdMapper, ServiceContext serviceContext)
      See Also:
    • findByUserId

      public static List<UserIdMapper> findByUserId(long userId)
      Returns all the user ID mappers where userId = ?.
      Parameters:
      userId - the user ID
      Returns:
      the matching user ID mappers
    • findByUserId

      public static List<UserIdMapper> findByUserId(long userId, int start, int end)
      Returns a range of all the user ID mappers where userId = ?.

      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, then the query will include the default ORDER BY logic from UserIdMapperModelImpl.

      Parameters:
      userId - the user ID
      start - the lower bound of the range of user ID mappers
      end - the upper bound of the range of user ID mappers (not inclusive)
      Returns:
      the range of matching user ID mappers
    • findByUserId

      public static List<UserIdMapper> findByUserId(long userId, int start, int end, OrderByComparator<UserIdMapper> orderByComparator)
      Returns an ordered range of all the user ID mappers where userId = ?.

      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, then the query will include the default ORDER BY logic from UserIdMapperModelImpl.

      Parameters:
      userId - the user ID
      start - the lower bound of the range of user ID mappers
      end - the upper bound of the range of user ID mappers (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of matching user ID mappers
    • findByUserId

      public static List<UserIdMapper> findByUserId(long userId, int start, int end, OrderByComparator<UserIdMapper> orderByComparator, boolean useFinderCache)
      Returns an ordered range of all the user ID mappers where userId = ?.

      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, then the query will include the default ORDER BY logic from UserIdMapperModelImpl.

      Parameters:
      userId - the user ID
      start - the lower bound of the range of user ID mappers
      end - the upper bound of the range of user ID mappers (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      useFinderCache - whether to use the finder cache
      Returns:
      the ordered range of matching user ID mappers
    • findByUserId_First

      public static UserIdMapper findByUserId_First(long userId, OrderByComparator<UserIdMapper> orderByComparator) throws NoSuchUserIdMapperException
      Returns the first user ID mapper in the ordered set where userId = ?.
      Parameters:
      userId - the user ID
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the first matching user ID mapper
      Throws:
      NoSuchUserIdMapperException - if a matching user ID mapper could not be found
      NoSuchUserIdMapperException
    • fetchByUserId_First

      public static UserIdMapper fetchByUserId_First(long userId, OrderByComparator<UserIdMapper> orderByComparator)
      Returns the first user ID mapper in the ordered set where userId = ?.
      Parameters:
      userId - the user ID
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the first matching user ID mapper, or null if a matching user ID mapper could not be found
    • findByUserId_Last

      public static UserIdMapper findByUserId_Last(long userId, OrderByComparator<UserIdMapper> orderByComparator) throws NoSuchUserIdMapperException
      Returns the last user ID mapper in the ordered set where userId = ?.
      Parameters:
      userId - the user ID
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the last matching user ID mapper
      Throws:
      NoSuchUserIdMapperException - if a matching user ID mapper could not be found
      NoSuchUserIdMapperException
    • fetchByUserId_Last

      public static UserIdMapper fetchByUserId_Last(long userId, OrderByComparator<UserIdMapper> orderByComparator)
      Returns the last user ID mapper in the ordered set where userId = ?.
      Parameters:
      userId - the user ID
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the last matching user ID mapper, or null if a matching user ID mapper could not be found
    • findByUserId_PrevAndNext

      public static UserIdMapper[] findByUserId_PrevAndNext(long userIdMapperId, long userId, OrderByComparator<UserIdMapper> orderByComparator) throws NoSuchUserIdMapperException
      Returns the user ID mappers before and after the current user ID mapper in the ordered set where userId = ?.
      Parameters:
      userIdMapperId - the primary key of the current user ID mapper
      userId - the user ID
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the previous, current, and next user ID mapper
      Throws:
      NoSuchUserIdMapperException - if a user ID mapper with the primary key could not be found
      NoSuchUserIdMapperException
    • removeByUserId

      public static void removeByUserId(long userId)
      Removes all the user ID mappers where userId = ? from the database.
      Parameters:
      userId - the user ID
    • countByUserId

      public static int countByUserId(long userId)
      Returns the number of user ID mappers where userId = ?.
      Parameters:
      userId - the user ID
      Returns:
      the number of matching user ID mappers
    • findByU_T

      public static UserIdMapper findByU_T(long userId, String type) throws NoSuchUserIdMapperException
      Returns the user ID mapper where userId = ? and type = ? or throws a NoSuchUserIdMapperException if it could not be found.
      Parameters:
      userId - the user ID
      type - the type
      Returns:
      the matching user ID mapper
      Throws:
      NoSuchUserIdMapperException - if a matching user ID mapper could not be found
      NoSuchUserIdMapperException
    • fetchByU_T

      public static UserIdMapper fetchByU_T(long userId, String type)
      Returns the user ID mapper where userId = ? and type = ? or returns null if it could not be found. Uses the finder cache.
      Parameters:
      userId - the user ID
      type - the type
      Returns:
      the matching user ID mapper, or null if a matching user ID mapper could not be found
    • fetchByU_T

      public static UserIdMapper fetchByU_T(long userId, String type, boolean useFinderCache)
      Returns the user ID mapper where userId = ? and type = ? or returns null if it could not be found, optionally using the finder cache.
      Parameters:
      userId - the user ID
      type - the type
      useFinderCache - whether to use the finder cache
      Returns:
      the matching user ID mapper, or null if a matching user ID mapper could not be found
    • removeByU_T

      public static UserIdMapper removeByU_T(long userId, String type) throws NoSuchUserIdMapperException
      Removes the user ID mapper where userId = ? and type = ? from the database.
      Parameters:
      userId - the user ID
      type - the type
      Returns:
      the user ID mapper that was removed
      Throws:
      NoSuchUserIdMapperException
    • countByU_T

      public static int countByU_T(long userId, String type)
      Returns the number of user ID mappers where userId = ? and type = ?.
      Parameters:
      userId - the user ID
      type - the type
      Returns:
      the number of matching user ID mappers
    • findByT_E

      public static UserIdMapper findByT_E(String type, String externalUserId) throws NoSuchUserIdMapperException
      Returns the user ID mapper where type = ? and externalUserId = ? or throws a NoSuchUserIdMapperException if it could not be found.
      Parameters:
      type - the type
      externalUserId - the external user ID
      Returns:
      the matching user ID mapper
      Throws:
      NoSuchUserIdMapperException - if a matching user ID mapper could not be found
      NoSuchUserIdMapperException
    • fetchByT_E

      public static UserIdMapper fetchByT_E(String type, String externalUserId)
      Returns the user ID mapper where type = ? and externalUserId = ? or returns null if it could not be found. Uses the finder cache.
      Parameters:
      type - the type
      externalUserId - the external user ID
      Returns:
      the matching user ID mapper, or null if a matching user ID mapper could not be found
    • fetchByT_E

      public static UserIdMapper fetchByT_E(String type, String externalUserId, boolean useFinderCache)
      Returns the user ID mapper where type = ? and externalUserId = ? or returns null if it could not be found, optionally using the finder cache.
      Parameters:
      type - the type
      externalUserId - the external user ID
      useFinderCache - whether to use the finder cache
      Returns:
      the matching user ID mapper, or null if a matching user ID mapper could not be found
    • removeByT_E

      public static UserIdMapper removeByT_E(String type, String externalUserId) throws NoSuchUserIdMapperException
      Removes the user ID mapper where type = ? and externalUserId = ? from the database.
      Parameters:
      type - the type
      externalUserId - the external user ID
      Returns:
      the user ID mapper that was removed
      Throws:
      NoSuchUserIdMapperException
    • countByT_E

      public static int countByT_E(String type, String externalUserId)
      Returns the number of user ID mappers where type = ? and externalUserId = ?.
      Parameters:
      type - the type
      externalUserId - the external user ID
      Returns:
      the number of matching user ID mappers
    • cacheResult

      public static void cacheResult(UserIdMapper userIdMapper)
      Caches the user ID mapper in the entity cache if it is enabled.
      Parameters:
      userIdMapper - the user ID mapper
    • cacheResult

      public static void cacheResult(List<UserIdMapper> userIdMappers)
      Caches the user ID mappers in the entity cache if it is enabled.
      Parameters:
      userIdMappers - the user ID mappers
    • create

      public static UserIdMapper create(long userIdMapperId)
      Creates a new user ID mapper with the primary key. Does not add the user ID mapper to the database.
      Parameters:
      userIdMapperId - the primary key for the new user ID mapper
      Returns:
      the new user ID mapper
    • remove

      public static UserIdMapper remove(long userIdMapperId) throws NoSuchUserIdMapperException
      Removes the user ID mapper with the primary key from the database. Also notifies the appropriate model listeners.
      Parameters:
      userIdMapperId - the primary key of the user ID mapper
      Returns:
      the user ID mapper that was removed
      Throws:
      NoSuchUserIdMapperException - if a user ID mapper with the primary key could not be found
      NoSuchUserIdMapperException
    • updateImpl

      public static UserIdMapper updateImpl(UserIdMapper userIdMapper)
    • findByPrimaryKey

      public static UserIdMapper findByPrimaryKey(long userIdMapperId) throws NoSuchUserIdMapperException
      Returns the user ID mapper with the primary key or throws a NoSuchUserIdMapperException if it could not be found.
      Parameters:
      userIdMapperId - the primary key of the user ID mapper
      Returns:
      the user ID mapper
      Throws:
      NoSuchUserIdMapperException - if a user ID mapper with the primary key could not be found
      NoSuchUserIdMapperException
    • fetchByPrimaryKey

      public static UserIdMapper fetchByPrimaryKey(long userIdMapperId)
      Returns the user ID mapper with the primary key or returns null if it could not be found.
      Parameters:
      userIdMapperId - the primary key of the user ID mapper
      Returns:
      the user ID mapper, or null if a user ID mapper with the primary key could not be found
    • findAll

      public static List<UserIdMapper> findAll()
      Returns all the user ID mappers.
      Returns:
      the user ID mappers
    • findAll

      public static List<UserIdMapper> findAll(int start, int end)
      Returns a range of all the user ID mappers.

      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, then the query will include the default ORDER BY logic from UserIdMapperModelImpl.

      Parameters:
      start - the lower bound of the range of user ID mappers
      end - the upper bound of the range of user ID mappers (not inclusive)
      Returns:
      the range of user ID mappers
    • findAll

      public static List<UserIdMapper> findAll(int start, int end, OrderByComparator<UserIdMapper> orderByComparator)
      Returns an ordered range of all the user ID mappers.

      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, then the query will include the default ORDER BY logic from UserIdMapperModelImpl.

      Parameters:
      start - the lower bound of the range of user ID mappers
      end - the upper bound of the range of user ID mappers (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of user ID mappers
    • findAll

      public static List<UserIdMapper> findAll(int start, int end, OrderByComparator<UserIdMapper> orderByComparator, boolean useFinderCache)
      Returns an ordered range of all the user ID mappers.

      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, then the query will include the default ORDER BY logic from UserIdMapperModelImpl.

      Parameters:
      start - the lower bound of the range of user ID mappers
      end - the upper bound of the range of user ID mappers (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      useFinderCache - whether to use the finder cache
      Returns:
      the ordered range of user ID mappers
    • removeAll

      public static void removeAll()
      Removes all the user ID mappers from the database.
    • countAll

      public static int countAll()
      Returns the number of user ID mappers.
      Returns:
      the number of user ID mappers
    • getPersistence

      public static UserIdMapperPersistence getPersistence()
    • setPersistence

      public static void setPersistence(UserIdMapperPersistence persistence)