Package com.aquima.interactions.project

Interface IUserData

All Superinterfaces:
Serializable
All Known Implementing Classes:
AnonymousUser, AutomaticUser, UserData
public interface IUserData extends Serializable
This interface defines several properties of the user for which a process action should be performed.
Since:
7.0
Author:
O. Kerpershoek

  • Method Details

    • getUserId

      String getUserId()
      This method returns an ID that uniquely identifies the user. This ID will for instance be used when locking a case to indicate which user performed the lock.
      Returns:
      The unique ID of the user, may not be null.

    • getUserName

      String getUserName()
      This method returns the name of the user this object represents. The name of the user is mainly used for display purposes. Use the user-ID to uniquely identify the user.
      Returns:
      the name of the user this object represents.

    • getRoles

      String[] getRoles()
      This method returns an array containing the names of the roles of the user.
      Returns:
      An array containing the names of the roles of the user, can be empty array, but may not be null.

    • getTeams

      String[] getTeams()
      This method returns an array containing the names of the teams of the user.
      Returns:
      An array containing the names of the teams of the user, can be empty array, but may not be null.

    • getTenant

      String getTenant()
      This method returns the name of the tenant.
      Returns:
      the name of the tenant.

    • addCustomProperty

      void addCustomProperty(String key, String value)
      This method puts a key with its value in the custom properties map If the key-value combination already exists an exception will be thrown
      Parameters:
      key - The name of the custom property
      value - The value of the custom property

    • getCustomProperty

      String getCustomProperty(String name)
      This methods returns the value of a key, if available, otherwise returns null
      Parameters:
      name - The name of the custom property
      Returns:
      the value of a key

    • hasCustomProperty

      boolean hasCustomProperty(String name)
      This method returns true if the key is available
      Parameters:
      name - The name of the custom property
      Returns:
      true if present, otherwise false

    • getCustomPropertyNames

      String[] getCustomPropertyNames()
      This method returns a string array containing custom properties names
      Returns:
      the map containing custom properties

    • setHeader

      void setHeader(String name, List<String> values)
      Stores the values for a header
      Parameters:
      name - The name of the header
      values - The values for the header

    • getHeader

      List<String> getHeader(String name)
      Returns the values of a header
      Parameters:
      name - The name of the header
      Returns:
      the values of the header

    • getHeaderNames

      Set<String> getHeaderNames()
      Returns the names of all stored headers
      Returns:
      list of header names

    • setAuthenticationClaim

      void setAuthenticationClaim(String name, List<String> values)
      Stores the values for an authentication claim
      Parameters:
      name - The name of the authentication claim
      values - The values for the authentication claim

    • getAuthenticationClaim

      List<String> getAuthenticationClaim(String name)
      Returns the values of an authentication claim
      Parameters:
      name - The name of the authentication claim
      Returns:
      the values of the authentication claim

    • getAuthenticationClaimNames

      Set<String> getAuthenticationClaimNames()
      Returns the names of all stored authentication claims
      Returns:
      set of authentication claim names

    • isAnonymous

      boolean isAnonymous()
      Returns:
      true if this user represents the anonymous user

    • isAutomatic

      boolean isAutomatic()
      Returns:
      true if this user represents the automatic user (Runtime Service Account)