com.liferay.portal.service
Interface UserIdMapperLocalService

All Known Implementing Classes:

UserIdMapperLocalServiceBaseImpl, UserIdMapperLocalServiceImpl, UserIdMapperLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface UserIdMapperLocalService

The interface for the user id mapper local service.

Never modify or reference this interface directly. Always use UserIdMapperLocalServiceUtil to access the user id mapper local service. Add custom service methods to UserIdMapperLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

UserIdMapperLocalServiceUtil, UserIdMapperLocalServiceBaseImpl, UserIdMapperLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

UserIdMapper	addUserIdMapper(UserIdMapper userIdMapper) Adds the user id mapper to the database.
UserIdMapper	createUserIdMapper(long userIdMapperId) Creates a new user id mapper with the primary key.
void	deleteUserIdMapper(long userIdMapperId) Deletes the user id mapper with the primary key from the database.
void	deleteUserIdMapper(UserIdMapper userIdMapper) Deletes the user id mapper from the database.
void	deleteUserIdMappers(long userId)
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Counts the number of rows that match the dynamic query.
UserIdMapper	getUserIdMapper(long userIdMapperId) Gets the user id mapper with the primary key.
UserIdMapper	getUserIdMapper(long userId, String type)
UserIdMapper	getUserIdMapperByExternalUserId(String type, String externalUserId)
List<UserIdMapper>	getUserIdMappers(int start, int end) Gets a range of all the user id mappers.
List<UserIdMapper>	getUserIdMappers(long userId)
int	getUserIdMappersCount() Gets the number of user id mappers.
UserIdMapper	updateUserIdMapper(long userId, String type, String description, String externalUserId)
UserIdMapper	updateUserIdMapper(UserIdMapper userIdMapper) Updates the user id mapper in the database.
UserIdMapper	updateUserIdMapper(UserIdMapper userIdMapper, boolean merge) Updates the user id mapper in the database.

Method Detail

addUserIdMapper

UserIdMapper addUserIdMapper(UserIdMapper userIdMapper)
                             throws SystemException

Adds the user id mapper to the database. Also notifies the appropriate model listeners.

Parameters:

userIdMapper - the user id mapper to add

Returns:

the user id mapper that was added

Throws:

SystemException - if a system exception occurred

createUserIdMapper

UserIdMapper createUserIdMapper(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

deleteUserIdMapper

void deleteUserIdMapper(long userIdMapperId)
                        throws PortalException,
                               SystemException

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

Throws:

PortalException - if a user id mapper with the primary key could not be found

SystemException - if a system exception occurred

deleteUserIdMapper

void deleteUserIdMapper(UserIdMapper userIdMapper)
                        throws SystemException

Deletes the user id mapper from the database. Also notifies the appropriate model listeners.

Parameters:

userIdMapper - the user id mapper to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

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:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

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:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getUserIdMapper

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserIdMapper getUserIdMapper(long userIdMapperId)
                             throws PortalException,
                                    SystemException

Gets the user id mapper with the primary key.

Parameters:

userIdMapperId - the primary key of the user id mapper to get

Returns:

the user id mapper

Throws:

PortalException - if a user id mapper with the primary key could not be found

SystemException - if a system exception occurred

getUserIdMappers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserIdMapper> getUserIdMappers(int start,
                                                                             int end)
                                    throws SystemException

Gets 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

getUserIdMappersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserIdMappersCount()
                          throws SystemException

Gets the number of user id mappers.

Returns:

the number of user id mappers

Throws:

SystemException - if a system exception occurred

updateUserIdMapper

UserIdMapper updateUserIdMapper(UserIdMapper userIdMapper)
                                throws SystemException

Updates the user id mapper in the database. Also notifies the appropriate model listeners.

Parameters:

userIdMapper - the user id mapper to update

Returns:

the user id mapper that was updated

Throws:

SystemException - if a system exception occurred

updateUserIdMapper

UserIdMapper updateUserIdMapper(UserIdMapper userIdMapper,
                                boolean merge)
                                throws SystemException

Updates the user id mapper in the database. Also notifies the appropriate model listeners.

Parameters:

userIdMapper - the user id mapper to update

merge - whether to merge the user id mapper with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the user id mapper that was updated

Throws:

SystemException - if a system exception occurred

deleteUserIdMappers

void deleteUserIdMappers(long userId)
                         throws SystemException

Throws:

SystemException

getUserIdMapper

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserIdMapper getUserIdMapper(long userId,
                                                                      String type)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

getUserIdMapperByExternalUserId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserIdMapper getUserIdMapperByExternalUserId(String type,
                                                                                      String externalUserId)
                                             throws PortalException,
                                                    SystemException

Throws:

PortalException

SystemException

getUserIdMappers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserIdMapper> getUserIdMappers(long userId)
                                    throws SystemException

Throws:

SystemException

updateUserIdMapper

UserIdMapper updateUserIdMapper(long userId,
                                String type,
                                String description,
                                String externalUserId)
                                throws SystemException

Throws:

SystemException