Class UserIdMapperUtil
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic void
cacheResult
(UserIdMapper userIdMapper) Caches the user ID mapper in the entity cache if it is enabled.static void
cacheResult
(List<UserIdMapper> userIdMappers) Caches the user ID mappers in the entity cache if it is enabled.static void
static void
clearCache
(UserIdMapper userIdMapper) static int
countAll()
Returns the number of user ID mappers.static int
countByT_E
(String type, String externalUserId) Returns the number of user ID mappers where type = ? and externalUserId = ?.static int
countByU_T
(long userId, 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 returnsnull
if it could not be found.static Map<Serializable,
UserIdMapper> fetchByPrimaryKeys
(Set<Serializable> primaryKeys) static UserIdMapper
fetchByT_E
(String type, String externalUserId) Returns the user ID mapper where type = ? and externalUserId = ? or returnsnull
if it could not be found.static UserIdMapper
fetchByT_E
(String type, String externalUserId, boolean useFinderCache) Returns the user ID mapper where type = ? and externalUserId = ? or returnsnull
if it could not be found, optionally using the finder cache.static UserIdMapper
fetchByU_T
(long userId, String type) Returns the user ID mapper where userId = ? and type = ? or returnsnull
if it could not be found.static UserIdMapper
fetchByU_T
(long userId, String type, boolean useFinderCache) Returns the user ID mapper where userId = ? and type = ? or returnsnull
if it could not be found, optionally using the finder cache.static UserIdMapper
fetchByUserId_First
(long userId, OrderByComparator<UserIdMapper> orderByComparator) Returns the first user ID mapper in the ordered set where userId = ?.static UserIdMapper
fetchByUserId_Last
(long userId, OrderByComparator<UserIdMapper> orderByComparator) Returns the last user ID mapper in the ordered set where userId = ?.static List<UserIdMapper>
findAll()
Returns all the user ID mappers.static List<UserIdMapper>
findAll
(int start, int end) Returns a range of all the user ID mappers.static List<UserIdMapper>
findAll
(int start, int end, OrderByComparator<UserIdMapper> orderByComparator) Returns an ordered range of all the user ID mappers.static List<UserIdMapper>
findAll
(int start, int end, OrderByComparator<UserIdMapper> orderByComparator, boolean useFinderCache) 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 aNoSuchUserIdMapperException
if it could not be found.static UserIdMapper
Returns the user ID mapper where type = ? and externalUserId = ? or throws aNoSuchUserIdMapperException
if it could not be found.static UserIdMapper
Returns the user ID mapper where userId = ? and type = ? or throws aNoSuchUserIdMapperException
if it could not be found.static List<UserIdMapper>
findByUserId
(long userId) Returns all the user ID mappers where userId = ?.static List<UserIdMapper>
findByUserId
(long userId, int start, int end) Returns a range of all the user ID mappers where userId = ?.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 = ?.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 = ?.static UserIdMapper
findByUserId_First
(long userId, OrderByComparator<UserIdMapper> orderByComparator) Returns the first user ID mapper in the ordered set where userId = ?.static UserIdMapper
findByUserId_Last
(long userId, OrderByComparator<UserIdMapper> orderByComparator) Returns the last user ID mapper in the ordered set where userId = ?.static UserIdMapper[]
findByUserId_PrevAndNext
(long userIdMapperId, long userId, OrderByComparator<UserIdMapper> orderByComparator) Returns the user ID mappers before and after the current user ID mapper in the ordered set where userId = ?.static List<UserIdMapper>
findWithDynamicQuery
(DynamicQuery dynamicQuery) static List<UserIdMapper>
findWithDynamicQuery
(DynamicQuery dynamicQuery, int start, int end) static List<UserIdMapper>
findWithDynamicQuery
(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<UserIdMapper> orderByComparator) static UserIdMapperPersistence
static UserIdMapper
remove
(long userIdMapperId) Removes the user ID mapper with the primary key from the database.static void
Removes all the user ID mappers from the database.static UserIdMapper
removeByT_E
(String type, String externalUserId) Removes the user ID mapper where type = ? and externalUserId = ? from the database.static UserIdMapper
removeByU_T
(long userId, 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.static void
setPersistence
(UserIdMapperPersistence persistence) static UserIdMapper
update
(UserIdMapper userIdMapper) static UserIdMapper
update
(UserIdMapper userIdMapper, ServiceContext serviceContext) static UserIdMapper
updateImpl
(UserIdMapper userIdMapper)
-
Constructor Details
-
UserIdMapperUtil
public UserIdMapperUtil()
-
-
Method Details
-
clearCache
public static void clearCache()- See Also:
-
clearCache
-
countWithDynamicQuery
-
fetchByPrimaryKeys
- See Also:
-
findWithDynamicQuery
-
findWithDynamicQuery
public static List<UserIdMapper> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end) -
findWithDynamicQuery
public static List<UserIdMapper> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<UserIdMapper> orderByComparator) -
update
-
update
-
findByUserId
Returns all the user ID mappers where userId = ?.- Parameters:
userId
- the user ID- Returns:
- the matching user ID mappers
-
findByUserId
Returns a range of all the user ID mappers where userId = ?.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromUserIdMapperModelImpl
.- Parameters:
userId
- the user IDstart
- the lower bound of the range of user ID mappersend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromUserIdMapperModelImpl
.- Parameters:
userId
- the user IDstart
- the lower bound of the range of user ID mappersend
- the upper bound of the range of user ID mappers (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromUserIdMapperModelImpl
.- Parameters:
userId
- the user IDstart
- the lower bound of the range of user ID mappersend
- the upper bound of the range of user ID mappers (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)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 IDorderByComparator
- the comparator to order the set by (optionallynull
)- Returns:
- the first matching user ID mapper
- Throws:
NoSuchUserIdMapperException
- if a matching user ID mapper could not be foundNoSuchUserIdMapperException
-
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 IDorderByComparator
- the comparator to order the set by (optionallynull
)- 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 IDorderByComparator
- the comparator to order the set by (optionallynull
)- Returns:
- the last matching user ID mapper
- Throws:
NoSuchUserIdMapperException
- if a matching user ID mapper could not be foundNoSuchUserIdMapperException
-
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 IDorderByComparator
- the comparator to order the set by (optionallynull
)- 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 mapperuserId
- the user IDorderByComparator
- the comparator to order the set by (optionallynull
)- Returns:
- the previous, current, and next user ID mapper
- Throws:
NoSuchUserIdMapperException
- if a user ID mapper with the primary key could not be foundNoSuchUserIdMapperException
-
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
Returns the user ID mapper where userId = ? and type = ? or throws aNoSuchUserIdMapperException
if it could not be found.- Parameters:
userId
- the user IDtype
- the type- Returns:
- the matching user ID mapper
- Throws:
NoSuchUserIdMapperException
- if a matching user ID mapper could not be foundNoSuchUserIdMapperException
-
fetchByU_T
Returns the user ID mapper where userId = ? and type = ? or returnsnull
if it could not be found. Uses the finder cache.- Parameters:
userId
- the user IDtype
- the type- Returns:
- the matching user ID mapper, or
null
if a matching user ID mapper could not be found
-
fetchByU_T
Returns the user ID mapper where userId = ? and type = ? or returnsnull
if it could not be found, optionally using the finder cache.- Parameters:
userId
- the user IDtype
- the typeuseFinderCache
- 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
Removes the user ID mapper where userId = ? and type = ? from the database.- Parameters:
userId
- the user IDtype
- the type- Returns:
- the user ID mapper that was removed
- Throws:
NoSuchUserIdMapperException
-
countByU_T
Returns the number of user ID mappers where userId = ? and type = ?.- Parameters:
userId
- the user IDtype
- 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 aNoSuchUserIdMapperException
if it could not be found.- Parameters:
type
- the typeexternalUserId
- the external user ID- Returns:
- the matching user ID mapper
- Throws:
NoSuchUserIdMapperException
- if a matching user ID mapper could not be foundNoSuchUserIdMapperException
-
fetchByT_E
Returns the user ID mapper where type = ? and externalUserId = ? or returnsnull
if it could not be found. Uses the finder cache.- Parameters:
type
- the typeexternalUserId
- the external user ID- Returns:
- the matching user ID mapper, or
null
if a matching user ID mapper could not be found
-
fetchByT_E
Returns the user ID mapper where type = ? and externalUserId = ? or returnsnull
if it could not be found, optionally using the finder cache.- Parameters:
type
- the typeexternalUserId
- the external user IDuseFinderCache
- 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 typeexternalUserId
- the external user ID- Returns:
- the user ID mapper that was removed
- Throws:
NoSuchUserIdMapperException
-
countByT_E
Returns the number of user ID mappers where type = ? and externalUserId = ?.- Parameters:
type
- the typeexternalUserId
- the external user ID- Returns:
- the number of matching user ID mappers
-
cacheResult
Caches the user ID mapper in the entity cache if it is enabled.- Parameters:
userIdMapper
- the user ID mapper
-
cacheResult
Caches the user ID mappers in the entity cache if it is enabled.- Parameters:
userIdMappers
- the user ID mappers
-
create
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
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 foundNoSuchUserIdMapperException
-
updateImpl
-
findByPrimaryKey
Returns the user ID mapper with the primary key or throws aNoSuchUserIdMapperException
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 foundNoSuchUserIdMapperException
-
fetchByPrimaryKey
Returns the user ID mapper with the primary key or returnsnull
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
Returns all the user ID mappers.- Returns:
- the user ID mappers
-
findAll
Returns a range of all the user ID mappers.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromUserIdMapperModelImpl
.- Parameters:
start
- the lower bound of the range of user ID mappersend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromUserIdMapperModelImpl
.- Parameters:
start
- the lower bound of the range of user ID mappersend
- the upper bound of the range of user ID mappers (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromUserIdMapperModelImpl
.- Parameters:
start
- the lower bound of the range of user ID mappersend
- the upper bound of the range of user ID mappers (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)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
-
setPersistence
-