com.liferay.portal.service
Class UserIdMapperLocalServiceUtil

java.lang.Object
  com.liferay.portal.service.UserIdMapperLocalServiceUtil

public class UserIdMapperLocalServiceUtil
extends Object

The utility for the user ID mapper local service. This utility wraps UserIdMapperLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

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:

UserIdMapperLocalService, UserIdMapperLocalServiceBaseImpl, UserIdMapperLocalServiceImpl

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

Constructor Summary

UserIdMapperLocalServiceUtil()

Method Summary

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 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 List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static 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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
static UserIdMapper	fetchUserIdMapper(long userIdMapperId)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
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 void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(UserIdMapperLocalService service) Deprecated.
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.
static UserIdMapper	updateUserIdMapper(UserIdMapper userIdMapper, boolean merge) Updates the user ID mapper in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.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)
                                    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

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

deleteUserIdMapper

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

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

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

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

fetchUserIdMapper

public static UserIdMapper fetchUserIdMapper(long userIdMapperId)
                                      throws SystemException

Throws:

SystemException

getUserIdMapper

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

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getUserIdMappers

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

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

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

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

updateUserIdMapper

public static UserIdMapper updateUserIdMapper(UserIdMapper userIdMapper,
                                              boolean merge)
                                       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

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

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

deleteUserIdMappers

public static void deleteUserIdMappers(long userId)
                                throws SystemException

Throws:

SystemException

getUserIdMapper

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

Throws:

PortalException

SystemException

getUserIdMapperByExternalUserId

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

Throws:

PortalException

SystemException

getUserIdMappers

public static List<UserIdMapper> getUserIdMappers(long userId)
                                           throws SystemException

Throws:

SystemException

updateUserIdMapper

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

Throws:

SystemException

getService

public static UserIdMapperLocalService getService()

setService

public void setService(UserIdMapperLocalService service)

Deprecated.