Liferay 6.0-ee

com.liferay.portal.service
Class UserIdMapperLocalServiceUtil

java.lang.Object
  extended by 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.

Never modify this class directly. Add custom service methods to UserIdMapperLocalServiceImpl and rerun ServiceBuilder to regenerate this class.

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 void deleteUserIdMapper(long userIdMapperId)
          Deletes the user id mapper with the primary key from the database.
static void deleteUserIdMapper(UserIdMapper userIdMapper)
          Deletes the user id mapper from the database.
static void deleteUserIdMappers(long userId)
           
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)
          Counts the number of rows that match the dynamic query.
static UserIdMapperLocalService getService()
           
static UserIdMapper getUserIdMapper(long userIdMapperId)
          Gets 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)
          Gets a range of all the user id mappers.
static List<UserIdMapper> getUserIdMappers(long userId)
           
static int getUserIdMappersCount()
          Gets the number of user id mappers.
 void setService(UserIdMapperLocalService service)
           
static UserIdMapper updateUserIdMapper(long userId, String type, String description, String externalUserId)
           
static UserIdMapper updateUserIdMapper(UserIdMapper userIdMapper)
          Updates the user id mapper in the database.
static UserIdMapper updateUserIdMapper(UserIdMapper userIdMapper, boolean merge)
          Updates the user id mapper in the database.
 
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 to add
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 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

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

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 to search with
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 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

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

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

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

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

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

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

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

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)

Liferay 6.0-ee