com.liferay.portal.kernel.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, UserIdMapperLocalServiceImpl

{$generated.description}

Method Summary

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.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
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()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
UserIdMapper	fetchUserIdMapper(long userIdMapperId)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
UserIdMapper	getUserIdMapper(long userIdMapperId) Returns 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) Returns a range of all the user ID mappers.
List<UserIdMapper>	getUserIdMappers(long userId)
int	getUserIdMappersCount() Returns 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 or adds it if it does not yet exist.

Method Detail

addUserIdMapper

@Indexable(type=REINDEX)
UserIdMapper addUserIdMapper(UserIdMapper userIdMapper)

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

createUserIdMapper

@Transactional(enabled=false)
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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteUserIdMapper

@Indexable(type=DELETE)
UserIdMapper deleteUserIdMapper(long userIdMapperId)
                                                 throws PortalException

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

deleteUserIdMapper

@Indexable(type=DELETE)
UserIdMapper deleteUserIdMapper(UserIdMapper userIdMapper)

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

deleteUserIdMappers

void deleteUserIdMappers(long userId)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end)

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

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end,
                                                                                            OrderByComparator<T> orderByComparator)

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

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchUserIdMapper

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

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getUserIdMapper

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

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

getUserIdMapper

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

Throws:

PortalException

getUserIdMapperByExternalUserId

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

Throws:

PortalException

getUserIdMappers

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

getUserIdMappers

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

getUserIdMappersCount

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

Returns the number of user ID mappers.

Returns:

the number of user ID mappers

updateUserIdMapper

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

updateUserIdMapper

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

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