Class UserGroupRoleLocalServiceUtil

Object
com.liferay.portal.kernel.service.UserGroupRoleLocalServiceUtil

public class UserGroupRoleLocalServiceUtil extends Object
Provides the local service utility for UserGroupRole. This utility wraps com.liferay.portal.service.impl.UserGroupRoleLocalServiceImpl 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 Details

    • UserGroupRoleLocalServiceUtil

      public UserGroupRoleLocalServiceUtil()
  • Method Details

    • addUserGroupRole

      public static UserGroupRole addUserGroupRole(long userId, long groupId, long roleId)
    • addUserGroupRole

      public static UserGroupRole addUserGroupRole(UserGroupRole userGroupRole)
      Adds the user group role to the database. Also notifies the appropriate model listeners.

      Important: Inspect UserGroupRoleLocalServiceImpl 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:
      userGroupRole - the user group role
      Returns:
      the user group role that was added
    • addUserGroupRoles

      public static List<UserGroupRole> addUserGroupRoles(long userId, long groupId, long[] roleIds)
    • addUserGroupRoles

      public static List<UserGroupRole> addUserGroupRoles(long[] userIds, long groupId, long roleId)
    • createPersistedModel

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • createUserGroupRole

      public static UserGroupRole createUserGroupRole(long userGroupRoleId)
      Creates a new user group role with the primary key. Does not add the user group role to the database.
      Parameters:
      userGroupRoleId - the primary key for the new user group role
      Returns:
      the new user group role
    • deletePersistedModel

      public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Throws:
      PortalException
    • deleteUserGroupRole

      public static UserGroupRole deleteUserGroupRole(long userGroupRoleId) throws PortalException
      Deletes the user group role with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect UserGroupRoleLocalServiceImpl 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:
      userGroupRoleId - the primary key of the user group role
      Returns:
      the user group role that was removed
      Throws:
      PortalException - if a user group role with the primary key could not be found
    • deleteUserGroupRole

      public static UserGroupRole deleteUserGroupRole(UserGroupRole userGroupRole)
      Deletes the user group role from the database. Also notifies the appropriate model listeners.

      Important: Inspect UserGroupRoleLocalServiceImpl 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:
      userGroupRole - the user group role
      Returns:
      the user group role that was removed
    • deleteUserGroupRoles

      public static void deleteUserGroupRoles(long groupId, int roleType)
    • deleteUserGroupRoles

      public static void deleteUserGroupRoles(long userId, long groupId, long[] roleIds)
    • deleteUserGroupRoles

      public static void deleteUserGroupRoles(long userId, long[] groupIds)
    • deleteUserGroupRoles

      public static void deleteUserGroupRoles(long[] userIds, long groupId)
    • deleteUserGroupRoles

      public static void deleteUserGroupRoles(long[] userIds, long groupId, int roleType)
    • deleteUserGroupRoles

      public static void deleteUserGroupRoles(long[] userIds, long groupId, long roleId)
    • deleteUserGroupRolesByGroupId

      public static void deleteUserGroupRolesByGroupId(long groupId)
    • deleteUserGroupRolesByRoleId

      public static void deleteUserGroupRolesByRoleId(long roleId)
    • deleteUserGroupRolesByUserId

      public static void deleteUserGroupRolesByUserId(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

      public static DynamicQuery dynamicQuery()
    • dynamicQuery

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

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

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

      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

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

      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

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

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

      public static UserGroupRole fetchUserGroupRole(long userGroupRoleId)
    • fetchUserGroupRole

      public static UserGroupRole fetchUserGroupRole(long userId, long groupId, long roleId)
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • getUserGroupRole

      public static UserGroupRole getUserGroupRole(long userGroupRoleId) throws PortalException
      Returns the user group role with the primary key.
      Parameters:
      userGroupRoleId - the primary key of the user group role
      Returns:
      the user group role
      Throws:
      PortalException - if a user group role with the primary key could not be found
    • getUserGroupRoles

      public static List<UserGroupRole> getUserGroupRoles(int start, int end)
      Returns a range of all the user group roles.

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

      Parameters:
      start - the lower bound of the range of user group roles
      end - the upper bound of the range of user group roles (not inclusive)
      Returns:
      the range of user group roles
    • getUserGroupRoles

      public static List<UserGroupRole> getUserGroupRoles(long userId)
    • getUserGroupRoles

      public static List<UserGroupRole> getUserGroupRoles(long userId, long groupId)
    • getUserGroupRoles

      public static List<UserGroupRole> getUserGroupRoles(long userId, long groupId, int start, int end)
    • getUserGroupRolesByGroup

      public static List<UserGroupRole> getUserGroupRolesByGroup(long groupId)
    • getUserGroupRolesByGroupAndRole

      public static List<UserGroupRole> getUserGroupRolesByGroupAndRole(long groupId, long roleId)
    • getUserGroupRolesByUserUserGroupAndGroup

      public static List<UserGroupRole> getUserGroupRolesByUserUserGroupAndGroup(long userId, long groupId)
    • getUserGroupRolesCount

      public static int getUserGroupRolesCount()
      Returns the number of user group roles.
      Returns:
      the number of user group roles
    • getUserGroupRolesCount

      public static int getUserGroupRolesCount(long userId, long groupId)
    • hasUserGroupRole

      public static boolean hasUserGroupRole(long userId, long groupId, long roleId)
    • hasUserGroupRole

      public static boolean hasUserGroupRole(long userId, long groupId, long roleId, boolean inherit)
    • hasUserGroupRole

      public static boolean hasUserGroupRole(long userId, long groupId, String roleName) throws PortalException
      Throws:
      PortalException
    • hasUserGroupRole

      public static boolean hasUserGroupRole(long userId, long groupId, String roleName, boolean inherit) throws PortalException
      Throws:
      PortalException
    • updateUserGroupRole

      public static UserGroupRole updateUserGroupRole(UserGroupRole userGroupRole)
      Updates the user group role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect UserGroupRoleLocalServiceImpl 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:
      userGroupRole - the user group role
      Returns:
      the user group role that was updated
    • getService

      public static UserGroupRoleLocalService getService()
    • setService

      public static void setService(UserGroupRoleLocalService service)