Class UserIdMapperLocalServiceUtil
com.liferay.portal.service.impl.UserIdMapperLocalServiceImpl
and
is an 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:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic UserIdMapper
addUserIdMapper
(UserIdMapper userIdMapper) Adds the user ID mapper to the database.static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) 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 <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static 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
static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static UserIdMapperLocalService
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
Returns the number of user ID mappers.static 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 or adds it if it does not yet exist.
-
Constructor Details
-
UserIdMapperLocalServiceUtil
public UserIdMapperLocalServiceUtil()
-
-
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
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - 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
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - 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
public static void deleteUserIdMappers(long userId) -
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
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
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
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
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
-
getActionableDynamicQuery
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getUserIdMapper
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
- Throws:
PortalException
-
getUserIdMapperByExternalUserId
public static UserIdMapper getUserIdMapperByExternalUserId(String type, String externalUserId) throws PortalException - Throws:
PortalException
-
getUserIdMappers
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
-
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
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
-
getService
-
setService
-