com.liferay.portal.service.persistence

Class UserIdMapperUtil

java.lang.Object

com.liferay.portal.service.persistence.UserIdMapperUtil

@ProviderType
public class UserIdMapperUtil
extends java.lang.Object

The persistence utility for the user ID mapper service. This utility wraps 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:

UserIdMapperPersistence, UserIdMapperPersistenceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
UserIdMapperUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	cacheResult(java.util.List<UserIdMapper> userIdMappers) Caches the user ID mappers in the entity cache if it is enabled.
static void	cacheResult(UserIdMapper userIdMapper) Caches the user ID mapper in the entity cache if it is enabled.
static void	clearCache()
static void	clearCache(UserIdMapper userIdMapper)
static int	countAll() Returns the number of user ID mappers.
static int	countByT_E(java.lang.String type, java.lang.String externalUserId) Returns the number of user ID mappers where type = ? and externalUserId = ?.
static int	countByU_T(long userId, java.lang.String type) Returns the number of user ID mappers where userId = ? and type = ?.
static int	countByUserId(long userId) Returns the number of user ID mappers where userId = ?.
static long	countWithDynamicQuery(DynamicQuery dynamicQuery)
static UserIdMapper	create(long userIdMapperId) Creates a new user ID mapper with the primary key.
static UserIdMapper	fetchByPrimaryKey(long userIdMapperId) Returns the user ID mapper with the primary key or returns null if it could not be found.
static UserIdMapper	fetchByT_E(java.lang.String type, java.lang.String externalUserId) Returns the user ID mapper where type = ? and externalUserId = ? or returns null if it could not be found.
static UserIdMapper	fetchByT_E(java.lang.String type, java.lang.String externalUserId, boolean retrieveFromCache) Returns the user ID mapper where type = ? and externalUserId = ? or returns null if it could not be found, optionally using the finder cache.
static UserIdMapper	fetchByU_T(long userId, java.lang.String type) Returns the user ID mapper where userId = ? and type = ? or returns null if it could not be found.
static UserIdMapper	fetchByU_T(long userId, java.lang.String type, boolean retrieveFromCache) Returns the user ID mapper where userId = ? and type = ? or returns null if it could not be found, optionally using the finder cache.
static UserIdMapper	fetchByUserId_First(long userId, OrderByComparator orderByComparator) Returns the first user ID mapper in the ordered set where userId = ?.
static UserIdMapper	fetchByUserId_Last(long userId, OrderByComparator orderByComparator) Returns the last user ID mapper in the ordered set where userId = ?.
static java.util.List<UserIdMapper>	findAll() Returns all the user ID mappers.
static java.util.List<UserIdMapper>	findAll(int start, int end) Returns a range of all the user ID mappers.
static java.util.List<UserIdMapper>	findAll(int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the user ID mappers.
static UserIdMapper	findByPrimaryKey(long userIdMapperId) Returns the user ID mapper with the primary key or throws a NoSuchUserIdMapperException if it could not be found.
static UserIdMapper	findByT_E(java.lang.String type, java.lang.String externalUserId) Returns the user ID mapper where type = ? and externalUserId = ? or throws a NoSuchUserIdMapperException if it could not be found.
static UserIdMapper	findByU_T(long userId, java.lang.String type) Returns the user ID mapper where userId = ? and type = ? or throws a NoSuchUserIdMapperException if it could not be found.
static UserIdMapper	findByUserId_First(long userId, OrderByComparator orderByComparator) Returns the first user ID mapper in the ordered set where userId = ?.
static UserIdMapper	findByUserId_Last(long userId, OrderByComparator orderByComparator) Returns the last user ID mapper in the ordered set where userId = ?.
static UserIdMapper[]	findByUserId_PrevAndNext(long userIdMapperId, long userId, OrderByComparator orderByComparator) Returns the user ID mappers before and after the current user ID mapper in the ordered set where userId = ?.
static java.util.List<UserIdMapper>	findByUserId(long userId) Returns all the user ID mappers where userId = ?.
static java.util.List<UserIdMapper>	findByUserId(long userId, int start, int end) Returns a range of all the user ID mappers where userId = ?.
static java.util.List<UserIdMapper>	findByUserId(long userId, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the user ID mappers where userId = ?.
static java.util.List<UserIdMapper>	findWithDynamicQuery(DynamicQuery dynamicQuery)
static java.util.List<UserIdMapper>	findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end)
static java.util.List<UserIdMapper>	findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
static UserIdMapperPersistence	getPersistence()
static UserIdMapper	remove(long userIdMapperId) Removes the user ID mapper with the primary key from the database.
static void	removeAll() Removes all the user ID mappers from the database.
static UserIdMapper	removeByT_E(java.lang.String type, java.lang.String externalUserId) Removes the user ID mapper where type = ? and externalUserId = ? from the database.
static UserIdMapper	removeByU_T(long userId, java.lang.String type) Removes the user ID mapper where userId = ? and type = ? from the database.
static void	removeByUserId(long userId) Removes all the user ID mappers where userId = ? from the database.
void	setPersistence(UserIdMapperPersistence persistence) Deprecated. As of 6.2.0
static UserIdMapper	update(UserIdMapper userIdMapper)
static UserIdMapper	update(UserIdMapper userIdMapper, ServiceContext serviceContext)
static UserIdMapper	updateImpl(UserIdMapper userIdMapper)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserIdMapperUtil

public UserIdMapperUtil()

Method Detail

clearCache

public static void clearCache()

See Also:

BasePersistence.clearCache()

clearCache

public static void clearCache(UserIdMapper userIdMapper)

See Also:

BasePersistence.clearCache(com.liferay.portal.model.BaseModel)

countWithDynamicQuery

public static long countWithDynamicQuery(DynamicQuery dynamicQuery)
                                  throws SystemException

Throws:

SystemException

See Also:

BasePersistence.countWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static java.util.List<UserIdMapper> findWithDynamicQuery(DynamicQuery dynamicQuery)
                                                         throws SystemException

Throws:

SystemException

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static java.util.List<UserIdMapper> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                int start,
                                                int end)
                                                         throws SystemException

Throws:

SystemException

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery, int, int)

findWithDynamicQuery

public static java.util.List<UserIdMapper> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                int start,
                                                int end,
                                                OrderByComparator orderByComparator)
                                                         throws SystemException

Throws:

SystemException

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator)

update

public static UserIdMapper update(UserIdMapper userIdMapper)
                           throws SystemException

Throws:

SystemException

See Also:

BasePersistence.update(com.liferay.portal.model.BaseModel)

update

public static UserIdMapper update(UserIdMapper userIdMapper,
                  ServiceContext serviceContext)
                           throws SystemException

Throws:

SystemException

See Also:

BasePersistence.update(com.liferay.portal.model.BaseModel, ServiceContext)

findByUserId

public static java.util.List<UserIdMapper> findByUserId(long userId)
                                                 throws SystemException

Returns all the user ID mappers where userId = ?.

Parameters:

userId - the user ID

Returns:

the matching user ID mappers

Throws:

SystemException - if a system exception occurred

findByUserId

public static java.util.List<UserIdMapper> findByUserId(long userId,
                                        int start,
                                        int end)
                                                 throws SystemException

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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from UserIdMapperModelImpl. 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:

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

Throws:

SystemException - if a system exception occurred

findByUserId

public static java.util.List<UserIdMapper> findByUserId(long userId,
                                        int start,
                                        int end,
                                        OrderByComparator orderByComparator)
                                                 throws SystemException

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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from UserIdMapperModelImpl. 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:

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

Throws:

SystemException - if a system exception occurred

findByUserId_First

public static UserIdMapper findByUserId_First(long userId,
                              OrderByComparator orderByComparator)
                                       throws NoSuchUserIdMapperException,
                                              SystemException

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

SystemException - if a system exception occurred

fetchByUserId_First

public static UserIdMapper fetchByUserId_First(long userId,
                               OrderByComparator orderByComparator)
                                        throws SystemException

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

Throws:

SystemException - if a system exception occurred

findByUserId_Last

public static UserIdMapper findByUserId_Last(long userId,
                             OrderByComparator orderByComparator)
                                      throws NoSuchUserIdMapperException,
                                             SystemException

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

SystemException - if a system exception occurred

fetchByUserId_Last

public static UserIdMapper fetchByUserId_Last(long userId,
                              OrderByComparator orderByComparator)
                                       throws SystemException

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

Throws:

SystemException - if a system exception occurred

findByUserId_PrevAndNext

public static UserIdMapper[] findByUserId_PrevAndNext(long userIdMapperId,
                                      long userId,
                                      OrderByComparator orderByComparator)
                                               throws NoSuchUserIdMapperException,
                                                      SystemException

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

SystemException - if a system exception occurred

removeByUserId

public static void removeByUserId(long userId)
                           throws SystemException

Removes all the user ID mappers where userId = ? from the database.

Parameters:

userId - the user ID

Throws:

SystemException - if a system exception occurred

countByUserId

public static int countByUserId(long userId)
                         throws SystemException

Returns the number of user ID mappers where userId = ?.

Parameters:

userId - the user ID

Returns:

the number of matching user ID mappers

Throws:

SystemException - if a system exception occurred

findByU_T

public static UserIdMapper findByU_T(long userId,
                     java.lang.String type)
                              throws NoSuchUserIdMapperException,
                                     SystemException

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

SystemException - if a system exception occurred

fetchByU_T

public static UserIdMapper fetchByU_T(long userId,
                      java.lang.String type)
                               throws SystemException

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

Throws:

SystemException - if a system exception occurred

fetchByU_T

public static UserIdMapper fetchByU_T(long userId,
                      java.lang.String type,
                      boolean retrieveFromCache)
                               throws SystemException

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

retrieveFromCache - whether to use the finder cache

Returns:

the matching user ID mapper, or null if a matching user ID mapper could not be found

Throws:

SystemException - if a system exception occurred

removeByU_T

public static UserIdMapper removeByU_T(long userId,
                       java.lang.String type)
                                throws NoSuchUserIdMapperException,
                                       SystemException

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:

SystemException - if a system exception occurred

NoSuchUserIdMapperException

countByU_T

public static int countByU_T(long userId,
             java.lang.String type)
                      throws SystemException

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

Throws:

SystemException - if a system exception occurred

findByT_E

public static UserIdMapper findByT_E(java.lang.String type,
                     java.lang.String externalUserId)
                              throws NoSuchUserIdMapperException,
                                     SystemException

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

SystemException - if a system exception occurred

fetchByT_E

public static UserIdMapper fetchByT_E(java.lang.String type,
                      java.lang.String externalUserId)
                               throws SystemException

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

Throws:

SystemException - if a system exception occurred

fetchByT_E

public static UserIdMapper fetchByT_E(java.lang.String type,
                      java.lang.String externalUserId,
                      boolean retrieveFromCache)
                               throws SystemException

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

retrieveFromCache - whether to use the finder cache

Returns:

the matching user ID mapper, or null if a matching user ID mapper could not be found

Throws:

SystemException - if a system exception occurred

removeByT_E

public static UserIdMapper removeByT_E(java.lang.String type,
                       java.lang.String externalUserId)
                                throws NoSuchUserIdMapperException,
                                       SystemException

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:

SystemException - if a system exception occurred

NoSuchUserIdMapperException

countByT_E

public static int countByT_E(java.lang.String type,
             java.lang.String externalUserId)
                      throws SystemException

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

Throws:

SystemException - if a system exception occurred

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(java.util.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,
                                  SystemException

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

SystemException - if a system exception occurred

updateImpl

public static UserIdMapper updateImpl(UserIdMapper userIdMapper)
                               throws SystemException

Throws:

SystemException

findByPrimaryKey

public static UserIdMapper findByPrimaryKey(long userIdMapperId)
                                     throws NoSuchUserIdMapperException,
                                            SystemException

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

SystemException - if a system exception occurred

fetchByPrimaryKey

public static UserIdMapper fetchByPrimaryKey(long userIdMapperId)
                                      throws SystemException

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

Throws:

SystemException - if a system exception occurred

findAll

public static java.util.List<UserIdMapper> findAll()
                                            throws SystemException

Returns all the user ID mappers.

Returns:

the user ID mappers

Throws:

SystemException - if a system exception occurred

findAll

public static java.util.List<UserIdMapper> findAll(int start,
                                   int end)
                                            throws SystemException

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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from UserIdMapperModelImpl. 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 ID mappers

end - the upper bound of the range of user ID mappers (not inclusive)

Returns:

the range of user ID mappers

Throws:

SystemException - if a system exception occurred

findAll

public static java.util.List<UserIdMapper> findAll(int start,
                                   int end,
                                   OrderByComparator orderByComparator)
                                            throws SystemException

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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from UserIdMapperModelImpl. 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 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

Throws:

SystemException - if a system exception occurred

removeAll

public static void removeAll()
                      throws SystemException

Removes all the user ID mappers from the database.

Throws:

SystemException - if a system exception occurred

countAll

public static int countAll()
                    throws SystemException

Returns the number of user ID mappers.

Returns:

the number of user ID mappers

Throws:

SystemException - if a system exception occurred

getPersistence

public static UserIdMapperPersistence getPersistence()

setPersistence

public void setPersistence(UserIdMapperPersistence persistence)

Deprecated. As of 6.2.0