com.liferay.portal.kernel.service.persistence

Interface UserIdMapperPersistence

All Superinterfaces:

BasePersistence<UserIdMapper>

@ProviderType
public interface UserIdMapperPersistence
extends BasePersistence<UserIdMapper>

The persistence interface for the user ID mapper service.

Caching information and settings can be found in portal.properties

Author:

Brian Wing Shun Chan

See Also:

UserIdMapperPersistenceImpl, UserIdMapperUtil

{$generated.description}

Method Summary

Modifier and Type	Method and Description
void	cacheResult(List<UserIdMapper> userIdMappers) Caches the user ID mappers in the entity cache if it is enabled.
void	cacheResult(UserIdMapper userIdMapper) Caches the user ID mapper in the entity cache if it is enabled.
int	countAll() Returns the number of user ID mappers.
int	countByT_E(String type, String externalUserId) Returns the number of user ID mappers where type = ? and externalUserId = ?.
int	countByU_T(long userId, String type) Returns the number of user ID mappers where userId = ? and type = ?.
int	countByUserId(long userId) Returns the number of user ID mappers where userId = ?.
UserIdMapper	create(long userIdMapperId) Creates a new user ID mapper with the primary key.
UserIdMapper	fetchByPrimaryKey(long userIdMapperId) Returns the user ID mapper with the primary key or returns null if it could not be found.
Map<Serializable,UserIdMapper>	fetchByPrimaryKeys(Set<Serializable> primaryKeys)
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.
UserIdMapper	fetchByT_E(String type, 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.
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.
UserIdMapper	fetchByU_T(long userId, 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.
UserIdMapper	fetchByUserId_First(long userId, OrderByComparator<UserIdMapper> orderByComparator) Returns the first user ID mapper in the ordered set where userId = ?.
UserIdMapper	fetchByUserId_Last(long userId, OrderByComparator<UserIdMapper> orderByComparator) Returns the last user ID mapper in the ordered set where userId = ?.
List<UserIdMapper>	findAll() Returns all the user ID mappers.
List<UserIdMapper>	findAll(int start, int end) Returns a range of all the user ID mappers.
List<UserIdMapper>	findAll(int start, int end, OrderByComparator<UserIdMapper> orderByComparator) Returns an ordered range of all the user ID mappers.
List<UserIdMapper>	findAll(int start, int end, OrderByComparator<UserIdMapper> orderByComparator, boolean retrieveFromCache) Returns an ordered range of all the user ID mappers.
UserIdMapper	findByPrimaryKey(long userIdMapperId) Returns the user ID mapper with the primary key or throws a NoSuchUserIdMapperException if it could not be found.
UserIdMapper	findByT_E(String type, String externalUserId) Returns the user ID mapper where type = ? and externalUserId = ? or throws a NoSuchUserIdMapperException if it could not be found.
UserIdMapper	findByU_T(long userId, String type) Returns the user ID mapper where userId = ? and type = ? or throws a NoSuchUserIdMapperException if it could not be found.
UserIdMapper	findByUserId_First(long userId, OrderByComparator<UserIdMapper> orderByComparator) Returns the first user ID mapper in the ordered set where userId = ?.
UserIdMapper	findByUserId_Last(long userId, OrderByComparator<UserIdMapper> orderByComparator) Returns the last user ID mapper in the ordered set where userId = ?.
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 = ?.
List<UserIdMapper>	findByUserId(long userId) Returns all the user ID mappers where userId = ?.
List<UserIdMapper>	findByUserId(long userId, int start, int end) Returns a range of all the user ID mappers where userId = ?.
List<UserIdMapper>	findByUserId(long userId, int start, int end, OrderByComparator<UserIdMapper> orderByComparator) Returns an ordered range of all the user ID mappers where userId = ?.
List<UserIdMapper>	findByUserId(long userId, int start, int end, OrderByComparator<UserIdMapper> orderByComparator, boolean retrieveFromCache) Returns an ordered range of all the user ID mappers where userId = ?.
Set<String>	getBadColumnNames()
UserIdMapper	remove(long userIdMapperId) Removes the user ID mapper with the primary key from the database.
void	removeAll() Removes all the user ID mappers from the database.
UserIdMapper	removeByT_E(String type, String externalUserId) Removes the user ID mapper where type = ? and externalUserId = ? from the database.
UserIdMapper	removeByU_T(long userId, String type) Removes the user ID mapper where userId = ? and type = ? from the database.
void	removeByUserId(long userId) Removes all the user ID mappers where userId = ? from the database.
UserIdMapper	updateImpl(UserIdMapper userIdMapper)

Methods inherited from interface com.liferay.portal.kernel.service.persistence.BasePersistence

clearCache, clearCache, clearCache, closeSession, countWithDynamicQuery, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, flush, getCurrentSession, getDataSource, getListeners, getModelClass, openSession, processException, registerListener, remove, remove, setDataSource, unregisterListener, update, update

Method Detail

findByUserId

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

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

findByUserId

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

findByUserId

List<UserIdMapper> findByUserId(long userId,
                                int start,
                                int end,
                                OrderByComparator<UserIdMapper> orderByComparator,
                                boolean retrieveFromCache)

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)

retrieveFromCache - whether to retrieve from the finder cache

Returns:

the ordered range of matching user ID mappers

findByUserId_First

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

fetchByUserId_First

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

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

fetchByUserId_Last

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

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

removeByUserId

void removeByUserId(long userId)

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

Parameters:

userId - the user ID

countByUserId

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

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

fetchByU_T

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

UserIdMapper fetchByU_T(long userId,
                        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.

Parameters:

userId - the user ID

type - the type

retrieveFromCache - whether to retrieve from the finder cache

Returns:

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

removeByU_T

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

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

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

fetchByT_E

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

UserIdMapper fetchByT_E(String type,
                        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.

Parameters:

type - the type

externalUserId - the external user ID

retrieveFromCache - whether to retrieve from the finder cache

Returns:

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

removeByT_E

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

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

void cacheResult(UserIdMapper userIdMapper)

Caches the user ID mapper in the entity cache if it is enabled.

Parameters:

userIdMapper - the user ID mapper

cacheResult

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

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

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

updateImpl

UserIdMapper updateImpl(UserIdMapper userIdMapper)

findByPrimaryKey

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

fetchByPrimaryKey

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

fetchByPrimaryKeys

Map<Serializable,UserIdMapper> fetchByPrimaryKeys(Set<Serializable> primaryKeys)

Specified by:

fetchByPrimaryKeys in interface BasePersistence<UserIdMapper>

findAll

List<UserIdMapper> findAll()

Returns all the user ID mappers.

Returns:

the user ID mappers

findAll

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

findAll

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

findAll

List<UserIdMapper> findAll(int start,
                           int end,
                           OrderByComparator<UserIdMapper> orderByComparator,
                           boolean retrieveFromCache)

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)

retrieveFromCache - whether to retrieve from the finder cache

Returns:

the ordered range of user ID mappers

removeAll

void removeAll()

Removes all the user ID mappers from the database.

countAll

int countAll()

Returns the number of user ID mappers.

Returns:

the number of user ID mappers

getBadColumnNames

Set<String> getBadColumnNames()

Specified by:

getBadColumnNames in interface BasePersistence<UserIdMapper>