Interface UserIdMapperLocalService

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

Provides the local service interface for UserIdMapper. 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}
  • Method Details

    • addUserIdMapper

      @Indexable(type=REINDEX) UserIdMapper addUserIdMapper(UserIdMapper userIdMapper)
      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

      PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      createPersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • createUserIdMapper

      @Transactional(enabled=false) 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
    • deletePersistedModel

      PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Specified by:
      deletePersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • deleteUserIdMapper

      @Indexable(type=DELETE) UserIdMapper deleteUserIdMapper(long userIdMapperId) throws PortalException
      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

      @Indexable(type=DELETE) UserIdMapper deleteUserIdMapper(UserIdMapper userIdMapper)
      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 interface PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface PersistedModelLocalService
    • 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 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.UserIdMapperModelImpl.

      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
    • 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 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.UserIdMapperModelImpl.

      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
    • 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 query
      projection - 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

    • 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 interface PersistedModelLocalService
      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 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.UserIdMapperModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<UserIdMapper> getUserIdMappers(long userId)
    • getUserIdMappersCount

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

      @Indexable(type=REINDEX) UserIdMapper updateUserIdMapper(UserIdMapper userIdMapper)
      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