Interface WorkflowUsers


  • public interface WorkflowUsers
    Workflow bean providing access to user related functionalities. Don't use this outside of a workflow. The bean will be accessible by using 'users' in your workflow expressions.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getCurrent()
      Return the current user name.
      java.util.UUID getRoleId​(java.lang.String roleName)
      Retrieves the role Id for the given roleName.
      java.util.Set<java.util.UUID> getRoleIds​(java.lang.String roleNames)
      Retrieves all the role Ids from a comma separated string of role names.
      java.util.Set<java.util.UUID> getUserIds​(java.lang.String expression)
      Retrieves all the user Ids from a comma separated string of user expressions.
      java.util.Set<java.util.UUID> getUserIdsFromRoles​(java.lang.String roles)
      Retrieve the userIds from a comma separated list of roles.
      java.util.Set<java.lang.String> getUserNames​(java.lang.String expression)
      Converts a Candidate user expression to a Set of user names using the current workflow business item.
      java.lang.String getUserNamesCsv​(java.lang.String expression)
      Converts a Candidate user expression to a comma separated list of user names using the current workflow business item.
      java.util.Set<java.lang.String> getUserNamesWithError​(java.lang.String expression)
      Converts a Candidate user expression to a Set of user names using the current workflow business item.
      java.util.Set<com.collibra.dgc.core.api.model.user.User> getUsers​(java.lang.String expression)
      Retrieves all the users from a comma separated string of user expressions.
      java.util.Set<com.collibra.dgc.core.api.model.user.User> getUsersFromRoles​(java.lang.String roles)
      Retrieve the users from a comma separated list of roles.
      boolean isEmpty​(java.lang.String expression)
      Analyses the given expression and indicates if the expression resolves to any user or not.
      void runAsUserById​(java.util.UUID userId, java.lang.Runnable runnable)
      Run the given runnable logic as a given user.
      void runAsUserByUserName​(java.lang.String userName, java.lang.Runnable runnable)
      Run the given runnable logic as a given user.
    • Method Detail

      • getUserIds

        java.util.Set<java.util.UUID> getUserIds​(java.lang.String expression)
        Retrieves all the user Ids from a comma separated string of user expressions.
        Parameters:
        expression - The comma separated list of user expressions
        Returns:
        A Set of user ids.
      • getUsers

        java.util.Set<com.collibra.dgc.core.api.model.user.User> getUsers​(java.lang.String expression)
        Retrieves all the users from a comma separated string of user expressions.
        Parameters:
        expression - The comma separated list of user expressions.
        Returns:
        A Set of Users.
      • getUserIdsFromRoles

        java.util.Set<java.util.UUID> getUserIdsFromRoles​(java.lang.String roles)
        Retrieve the userIds from a comma separated list of roles.
        Parameters:
        roles - The csv string of roles to convert to user Ids.
        Returns:
        A set of user ids.
      • getUsersFromRoles

        java.util.Set<com.collibra.dgc.core.api.model.user.User> getUsersFromRoles​(java.lang.String roles)
        Retrieve the users from a comma separated list of roles.
        Parameters:
        roles - The csv of roles to convert to users.
        Returns:
        A Set of Users.
      • getRoleIds

        java.util.Set<java.util.UUID> getRoleIds​(java.lang.String roleNames)
        Retrieves all the role Ids from a comma separated string of role names. When a corresponding role is not found for a given role name, no roleId is added to the result Set.
        Parameters:
        roleNames - The comma separated list of role names
        Returns:
        A Set of role ids.
      • getRoleId

        java.util.UUID getRoleId​(java.lang.String roleName)
        Retrieves the role Id for the given roleName.
        Parameters:
        roleName - The name of the role to retrieve the role id for.
        Returns:
        The roleId of the given roleName, null if role not found
      • runAsUserById

        void runAsUserById​(java.util.UUID userId,
                           java.lang.Runnable runnable)
        Run the given runnable logic as a given user. The logic will be executed in a separate transaction.
        Parameters:
        userId - the user id of the user
        runnable - the runnable logic
      • getCurrent

        java.lang.String getCurrent()
        Return the current user name.
        Returns:
        the current user name
      • getUserNamesCsv

        java.lang.String getUserNamesCsv​(java.lang.String expression)
        Converts a Candidate user expression to a comma separated list of user names using the current workflow business item.
        Parameters:
        expression - The candidate user expression
        Returns:
        A String of user names, comma separated
      • getUserNames

        java.util.Set<java.lang.String> getUserNames​(java.lang.String expression)
        Converts a Candidate user expression to a Set of user names using the current workflow business item.
        Parameters:
        expression - The candidate user expression
        Returns:
        A Set of user names
      • isEmpty

        boolean isEmpty​(java.lang.String expression)
        Analyses the given expression and indicates if the expression resolves to any user or not.
        Parameters:
        expression - The expression to check for emptyness
        Returns:
        true if the expression is empty, false otherwise.
      • getUserNamesWithError

        java.util.Set<java.lang.String> getUserNamesWithError​(java.lang.String expression)
        Converts a Candidate user expression to a Set of user names using the current workflow business item.
        Parameters:
        expression - The candidate user expression
        Returns:
        A Set of user names
      • runAsUserByUserName

        void runAsUserByUserName​(java.lang.String userName,
                                 java.lang.Runnable runnable)
        Run the given runnable logic as a given user. The logic will be executed in a separate transaction.
        Parameters:
        userName - the username of the user
        runnable - the runnable logic