Interface UserIdMapperLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
UserIdMapperLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddUserIdMapper
(UserIdMapper userIdMapper) Adds the user ID mapper to the database.createPersistedModel
(Serializable primaryKeyObj) createUserIdMapper
(long userIdMapperId) Creates a new user ID mapper with the primary key.deletePersistedModel
(PersistedModel persistedModel) deleteUserIdMapper
(long userIdMapperId) Deletes the user ID mapper with the primary key from the database.deleteUserIdMapper
(UserIdMapper userIdMapper) Deletes the user ID mapper from the database.void
deleteUserIdMappers
(long userId) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <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.fetchUserIdMapper
(long userIdMapperId) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getUserIdMapper
(long userIdMapperId) Returns the user ID mapper with the primary key.getUserIdMapper
(long userId, String type) getUserIdMapperByExternalUserId
(String type, String externalUserId) getUserIdMappers
(int start, int end) Returns a range of all the user ID mappers.getUserIdMappers
(long userId) int
Returns the number of user ID mappers.updateUserIdMapper
(long userId, String type, String description, String externalUserId) updateUserIdMapper
(UserIdMapper userIdMapper) Updates the user ID mapper in the database or adds it if it does not yet exist.Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addUserIdMapper
Adds the user ID mapper to the database. Also notifies the appropriate model listeners.Important: Inspect UserIdMapperLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
userIdMapper
- the user ID mapper- Returns:
- the user ID mapper that was added
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
createUserIdMapper
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
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteUserIdMapper
Deletes the user ID mapper with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect UserIdMapperLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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
Deletes the user ID mapper from the database. Also notifies the appropriate model listeners.Important: Inspect UserIdMapperLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
userIdMapper
- the user ID mapper- Returns:
- the user ID mapper that was removed
-
deleteUserIdMappers
void deleteUserIdMappers(long userId) -
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.UserIdMapperModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.UserIdMapperModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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 queryprojection
- 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 interfacePersistedModelLocalService
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.UserIdMapperModelImpl
.- Parameters:
start
- the lower bound of the range of user ID mappersend
- 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
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
Updates the user ID mapper in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect UserIdMapperLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
userIdMapper
- the user ID mapper- Returns:
- the user ID mapper that was updated
-