com.liferay.portal.kernel.service

Class UserIdMapperLocalServiceUtil

Object

com.liferay.portal.kernel.service.UserIdMapperLocalServiceUtil

@ProviderType
public class UserIdMapperLocalServiceUtil
extends Object

Provides the local service utility for UserIdMapper. This utility wraps UserIdMapperLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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:

UserIdMapperLocalService, UserIdMapperLocalServiceBaseImpl, UserIdMapperLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
UserIdMapperLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static UserIdMapper	addUserIdMapper(UserIdMapper userIdMapper) Adds the user ID mapper to the database.
static UserIdMapper	createUserIdMapper(long userIdMapperId) Creates a new user ID mapper with the primary key.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static UserIdMapper	deleteUserIdMapper(long userIdMapperId) Deletes the user ID mapper with the primary key from the database.
static UserIdMapper	deleteUserIdMapper(UserIdMapper userIdMapper) Deletes the user ID mapper from the database.
static void	deleteUserIdMappers(long userId)
static DynamicQuery	dynamicQuery()
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <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.
static <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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static UserIdMapper	fetchUserIdMapper(long userIdMapperId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static UserIdMapperLocalService	getService()
static UserIdMapper	getUserIdMapper(long userIdMapperId) Returns the user ID mapper with the primary key.
static UserIdMapper	getUserIdMapper(long userId, String type)
static UserIdMapper	getUserIdMapperByExternalUserId(String type, String externalUserId)
static List<UserIdMapper>	getUserIdMappers(int start, int end) Returns a range of all the user ID mappers.
static List<UserIdMapper>	getUserIdMappers(long userId)
static int	getUserIdMappersCount() Returns the number of user ID mappers.
static UserIdMapper	updateUserIdMapper(long userId, String type, String description, String externalUserId)
static UserIdMapper	updateUserIdMapper(UserIdMapper userIdMapper) Updates the user ID mapper in the database or adds it if it does not yet exist.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserIdMapperLocalServiceUtil

public UserIdMapperLocalServiceUtil()

Method Detail

addUserIdMapper

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

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

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteUserIdMapper

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

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

public static void deleteUserIdMappers(long userId)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

public static UserIdMapper fetchUserIdMapper(long userIdMapperId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getUserIdMapper

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

public static UserIdMapper getUserIdMapper(long userId,
                                           String type)
                                    throws PortalException

Throws:

PortalException

getUserIdMapperByExternalUserId

public static UserIdMapper getUserIdMapperByExternalUserId(String type,
                                                           String externalUserId)
                                                    throws PortalException

Throws:

PortalException

getUserIdMappers

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

public static List<UserIdMapper> getUserIdMappers(long userId)

getUserIdMappersCount

public static int getUserIdMappersCount()

Returns the number of user ID mappers.

Returns:

the number of user ID mappers

updateUserIdMapper

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

updateUserIdMapper

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

getService

public static UserIdMapperLocalService getService()