Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Interface UserIdMapperLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
UserIdMapperLocalServiceWrapper

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

The interface for the user ID mapper local service.

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:
UserIdMapperLocalServiceUtil, UserIdMapperLocalServiceBaseImpl, com.liferay.portal.service.impl.UserIdMapperLocalServiceImpl

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

Method Detail

addUserIdMapper

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

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

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

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

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

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

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

@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(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getUserIdMappers

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

@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

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

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

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(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,
                                                                      String type)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

getUserIdMapperByExternalUserId

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

getUserIdMappers

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

updateUserIdMapper

UserIdMapper updateUserIdMapper(long userId,
                                String type,
                                String description,
                                String externalUserId)
                                throws SystemException
Throws:
SystemException

Liferay 6.1.2-ce-ga3