com.liferay.portal.service

Interface UserIdMapperLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

UserIdMapperLocalServiceWrapper

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

Provides the local service interface for UserIdMapper. 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.

Author:

Brian Wing Shun Chan

See Also:

UserIdMapperLocalServiceUtil, UserIdMapperLocalServiceBaseImpl, com.liferay.portal.service.impl.UserIdMapperLocalServiceImpl

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
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.
UserIdMapper	deleteUserIdMapper(long userIdMapperId) Deletes the user ID mapper with the primary key from the database.
UserIdMapper	deleteUserIdMapper(UserIdMapper userIdMapper) Deletes the user ID mapper from the database.
void	deleteUserIdMappers(long userId)
DynamicQuery	dynamicQuery()
java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
java.util.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) Returns the number of rows that match the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
UserIdMapper	fetchUserIdMapper(long userIdMapperId)
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
UserIdMapper	getUserIdMapper(long userIdMapperId) Returns the user ID mapper with the primary key.
UserIdMapper	getUserIdMapper(long userId, java.lang.String type)
UserIdMapper	getUserIdMapperByExternalUserId(java.lang.String type, java.lang.String externalUserId)
java.util.List<UserIdMapper>	getUserIdMappers(int start, int end) Returns a range of all the user ID mappers.
java.util.List<UserIdMapper>	getUserIdMappers(long userId)
int	getUserIdMappersCount() Returns the number of user ID mappers.
void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
UserIdMapper	updateUserIdMapper(long userId, java.lang.String type, java.lang.String description, java.lang.String externalUserId)
UserIdMapper	updateUserIdMapper(UserIdMapper userIdMapper) Updates the user ID mapper in the database or adds it if it does not yet exist.

Method Detail

addUserIdMapper

@Indexable(type=REINDEX)
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

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

@Indexable(type=DELETE)
UserIdMapper 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

Returns:

the user ID mapper that was removed

Throws:

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

SystemException - if a system exception occurred

deleteUserIdMapper

@Indexable(type=DELETE)
UserIdMapper 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

Returns:

the user ID mapper that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery)
                            throws SystemException

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

java.util.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. 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:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

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

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

java.util.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. 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:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

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

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                     Projection projection)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchUserIdMapper

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

Throws:

SystemException

getUserIdMapper

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

Returns the user ID mapper with the primary key.

Parameters:

userIdMapperId - the primary key of the user ID mapper

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

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getUserIdMappers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<UserIdMapper> getUserIdMappers(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

getUserIdMappersCount

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

Returns the number of user ID mappers.

Returns:

the number of user ID mappers

Throws:

SystemException - if a system exception occurred

updateUserIdMapper

@Indexable(type=REINDEX)
UserIdMapper updateUserIdMapper(UserIdMapper userIdMapper)
                                throws SystemException

Updates the user ID mapper in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

userIdMapper - the user ID mapper

Returns:

the user ID mapper that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

deleteUserIdMappers

void deleteUserIdMappers(long userId)
                         throws SystemException

Throws:

SystemException

getUserIdMapper

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

Throws:

PortalException

SystemException

getUserIdMapperByExternalUserId

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

Throws:

PortalException

SystemException

getUserIdMappers

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

Throws:

SystemException

updateUserIdMapper

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

Throws:

SystemException