Liferay 6.0.5

com.liferay.portal.service.persistence
Interface UserIdMapperPersistence

All Superinterfaces:
BasePersistence<UserIdMapper>
All Known Implementing Classes:
UserIdMapperPersistenceImpl

public interface UserIdMapperPersistence
extends BasePersistence<UserIdMapper>

The persistence interface for the user id mapper service.

Never modify or reference this interface directly. Always use UserIdMapperUtil to access the user id mapper persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.

Caching information and settings can be found in portal.properties

See Also:
UserIdMapperPersistenceImpl, UserIdMapperUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 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()
          Counts all the user id mappers.
 int countByT_E(String type, String externalUserId)
          Counts all the user id mappers where type = ? and externalUserId = ?.
 int countByU_T(long userId, String type)
          Counts all the user id mappers where userId = ? and type = ?.
 int countByUserId(long userId)
          Counts all the user id mappers where userId = ?.
 UserIdMapper create(long userIdMapperId)
          Creates a new user id mapper with the primary key.
 UserIdMapper fetchByPrimaryKey(long userIdMapperId)
          Finds the user id mapper with the primary key or returns null if it could not be found.
 UserIdMapper fetchByT_E(String type, String externalUserId)
          Finds 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)
          Finds 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)
          Finds 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)
          Finds the user id mapper where userId = ? and type = ? or returns null if it could not be found, optionally using the finder cache.
 List<UserIdMapper> findAll()
          Finds all the user id mappers.
 List<UserIdMapper> findAll(int start, int end)
          Finds a range of all the user id mappers.
 List<UserIdMapper> findAll(int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the user id mappers.
 UserIdMapper findByPrimaryKey(long userIdMapperId)
          Finds 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)
          Finds 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)
          Finds the user id mapper where userId = ? and type = ? or throws a NoSuchUserIdMapperException if it could not be found.
 UserIdMapper findByUserId_First(long userId, OrderByComparator orderByComparator)
          Finds the first user id mapper in the ordered set where userId = ?.
 UserIdMapper findByUserId_Last(long userId, OrderByComparator orderByComparator)
          Finds the last user id mapper in the ordered set where userId = ?.
 UserIdMapper[] findByUserId_PrevAndNext(long userIdMapperId, long userId, OrderByComparator orderByComparator)
          Finds the user id mappers before and after the current user id mapper in the ordered set where userId = ?.
 List<UserIdMapper> findByUserId(long userId)
          Finds all the user id mappers where userId = ?.
 List<UserIdMapper> findByUserId(long userId, int start, int end)
          Finds a range of all the user id mappers where userId = ?.
 List<UserIdMapper> findByUserId(long userId, int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the user id mappers where userId = ?.
 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.
 void removeByT_E(String type, String externalUserId)
          Removes the user id mapper where type = ? and externalUserId = ? from the database.
 void 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, boolean merge)
           
 
Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence
clearCache, clearCache, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, getDataSource, getListeners, registerListener, remove, remove, setDataSource, unregisterListener, update, update
 

Method Detail

cacheResult

void cacheResult(UserIdMapper userIdMapper)
Caches the user id mapper in the entity cache if it is enabled.

Parameters:
userIdMapper - the user id mapper to cache

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

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,
                           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 to remove
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

UserIdMapper updateImpl(UserIdMapper userIdMapper,
                        boolean merge)
                        throws SystemException
Throws:
SystemException

findByPrimaryKey

UserIdMapper findByPrimaryKey(long userIdMapperId)
                              throws NoSuchUserIdMapperException,
                                     SystemException
Finds 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 to find
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

UserIdMapper fetchByPrimaryKey(long userIdMapperId)
                               throws SystemException
Finds 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 to find
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

findByUserId

List<UserIdMapper> findByUserId(long userId)
                                throws SystemException
Finds all the user id mappers where userId = ?.

Parameters:
userId - the user id to search with
Returns:
the matching user id mappers
Throws:
SystemException - if a system exception occurred

findByUserId

List<UserIdMapper> findByUserId(long userId,
                                int start,
                                int end)
                                throws SystemException
Finds 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.

Parameters:
userId - the user id to search with
start - the lower bound of the range of user id mappers to return
end - the upper bound of the range of user id mappers to return (not inclusive)
Returns:
the range of matching user id mappers
Throws:
SystemException - if a system exception occurred

findByUserId

List<UserIdMapper> findByUserId(long userId,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                                throws SystemException
Finds 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.

Parameters:
userId - the user id to search with
start - the lower bound of the range of user id mappers to return
end - the upper bound of the range of user id mappers to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching user id mappers
Throws:
SystemException - if a system exception occurred

findByUserId_First

UserIdMapper findByUserId_First(long userId,
                                OrderByComparator orderByComparator)
                                throws NoSuchUserIdMapperException,
                                       SystemException
Finds the first user id mapper in the ordered set 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.

Parameters:
userId - the user id to search with
orderByComparator - the comparator to order the set by
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

findByUserId_Last

UserIdMapper findByUserId_Last(long userId,
                               OrderByComparator orderByComparator)
                               throws NoSuchUserIdMapperException,
                                      SystemException
Finds the last user id mapper in the ordered set 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.

Parameters:
userId - the user id to search with
orderByComparator - the comparator to order the set by
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

findByUserId_PrevAndNext

UserIdMapper[] findByUserId_PrevAndNext(long userIdMapperId,
                                        long userId,
                                        OrderByComparator orderByComparator)
                                        throws NoSuchUserIdMapperException,
                                               SystemException
Finds the user id mappers before and after the current user id mapper in the ordered set 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.

Parameters:
userIdMapperId - the primary key of the current user id mapper
userId - the user id to search with
orderByComparator - the comparator to order the set by
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

findByU_T

UserIdMapper findByU_T(long userId,
                       String type)
                       throws NoSuchUserIdMapperException,
                              SystemException
Finds the user id mapper where userId = ? and type = ? or throws a NoSuchUserIdMapperException if it could not be found.

Parameters:
userId - the user id to search with
type - the type to search with
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

UserIdMapper fetchByU_T(long userId,
                        String type)
                        throws SystemException
Finds 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 to search with
type - the type to search with
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

UserIdMapper fetchByU_T(long userId,
                        String type,
                        boolean retrieveFromCache)
                        throws SystemException
Finds 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 to search with
type - the type to search with
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

findByT_E

UserIdMapper findByT_E(String type,
                       String externalUserId)
                       throws NoSuchUserIdMapperException,
                              SystemException
Finds the user id mapper where type = ? and externalUserId = ? or throws a NoSuchUserIdMapperException if it could not be found.

Parameters:
type - the type to search with
externalUserId - the external user id to search with
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

UserIdMapper fetchByT_E(String type,
                        String externalUserId)
                        throws SystemException
Finds 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 to search with
externalUserId - the external user id to search with
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

UserIdMapper fetchByT_E(String type,
                        String externalUserId,
                        boolean retrieveFromCache)
                        throws SystemException
Finds 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 to search with
externalUserId - the external user id to search with
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

findAll

List<UserIdMapper> findAll()
                           throws SystemException
Finds all the user id mappers.

Returns:
the user id mappers
Throws:
SystemException - if a system exception occurred

findAll

List<UserIdMapper> findAll(int start,
                           int end)
                           throws SystemException
Finds 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.

Parameters:
start - the lower bound of the range of user id mappers to return
end - the upper bound of the range of user id mappers to return (not inclusive)
Returns:
the range of user id mappers
Throws:
SystemException - if a system exception occurred

findAll

List<UserIdMapper> findAll(int start,
                           int end,
                           OrderByComparator orderByComparator)
                           throws SystemException
Finds 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.

Parameters:
start - the lower bound of the range of user id mappers to return
end - the upper bound of the range of user id mappers to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of user id mappers
Throws:
SystemException - if a system exception occurred

removeByUserId

void removeByUserId(long userId)
                    throws SystemException
Removes all the user id mappers where userId = ? from the database.

Parameters:
userId - the user id to search with
Throws:
SystemException - if a system exception occurred

removeByU_T

void removeByU_T(long userId,
                 String type)
                 throws NoSuchUserIdMapperException,
                        SystemException
Removes the user id mapper where userId = ? and type = ? from the database.

Parameters:
userId - the user id to search with
type - the type to search with
Throws:
SystemException - if a system exception occurred
NoSuchUserIdMapperException

removeByT_E

void removeByT_E(String type,
                 String externalUserId)
                 throws NoSuchUserIdMapperException,
                        SystemException
Removes the user id mapper where type = ? and externalUserId = ? from the database.

Parameters:
type - the type to search with
externalUserId - the external user id to search with
Throws:
SystemException - if a system exception occurred
NoSuchUserIdMapperException

removeAll

void removeAll()
               throws SystemException
Removes all the user id mappers from the database.

Throws:
SystemException - if a system exception occurred

countByUserId

int countByUserId(long userId)
                  throws SystemException
Counts all the user id mappers where userId = ?.

Parameters:
userId - the user id to search with
Returns:
the number of matching user id mappers
Throws:
SystemException - if a system exception occurred

countByU_T

int countByU_T(long userId,
               String type)
               throws SystemException
Counts all the user id mappers where userId = ? and type = ?.

Parameters:
userId - the user id to search with
type - the type to search with
Returns:
the number of matching user id mappers
Throws:
SystemException - if a system exception occurred

countByT_E

int countByT_E(String type,
               String externalUserId)
               throws SystemException
Counts all the user id mappers where type = ? and externalUserId = ?.

Parameters:
type - the type to search with
externalUserId - the external user id to search with
Returns:
the number of matching user id mappers
Throws:
SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException
Counts all the user id mappers.

Returns:
the number of user id mappers
Throws:
SystemException - if a system exception occurred

Liferay 6.0.5