Module com.genologics.ri
Package com.genologics.ri.researcher

Class Role

java.lang.Object
com.genologics.ri.LimsLinkBase<Role>
com.genologics.ri.researcher.Role
All Implemented Interfaces:
LimsLink<Role>, Linkable<Role>, Locatable, Serializable
public class Role extends LimsLinkBase<Role>
The role element defines a researcher's level of access in the system. You can repeat the element to provide a researcher with access to more than one area of the system. When submitting a PUT request to update a researcher's credentials (any child elements within the credentials element), your XML must include the current roles for the researcher. If you do not include all of the current roles, the system will remove the current data and the researcher will no longer have access to the system. When adding a new role you must provide at least one of: URI, name, or roleName.
See Also:

  • Field Details

    • SYSTEM_ADMIN_ROLE

      public static final String SYSTEM_ADMIN_ROLE
      The name for the system administrator role.
      See Also:

    • CLARITY_ROLE

      public static final String CLARITY_ROLE
      The name for the researcher role.
      See Also:

    • ADMIN_ROLE

      public static final String ADMIN_ROLE
      The name for the facility administrator role.
      See Also:

    • roleName

      @Deprecated protected String roleName
      Deprecated.
      Deprecated from version 2.19.
      The role name. Deprecated from version 2.19.

    • name

      protected String name
      The user-facing name of the security role.
      Since:
      2.19

    • uri

      protected URI uri
      The URI to the role.
      Since:
      2.19

  • Constructor Details

    • Role

      public Role()
      Default constructor.

    • Role

      public Role(URI uri)
      Constructor with URI.
      Parameters:
      uri - The URI to the role.

    • Role

      public Role(URI uri, String name)
      Constructor with URI and name.
      Parameters:
      uri - The URI to the role.
      name - The name of the role.

    • Role

      public Role(Linkable<Role> link)
      Constructor from a linkable object.
      Parameters:
      link - The linkable object containing the role URI.

    • Role

      public Role(Role otherRole)
      Constructor from another role object.
      Parameters:
      otherRole - The role to create this role from.

  • Method Details

    • getRoleName

      @Deprecated public String getRoleName()
      Deprecated.
      Deprecated from version 2.19.
      The name of the security role assigned to the researcher. Only used by built-in roles. Acceptable values are: "systemadministrator", "administrator", "labtech", and "webclient".
      Returns:
      The role name.

    • setRoleName

      @Deprecated public void setRoleName(String value)
      Deprecated.
      Deprecated from version 2.19.
      Set the role name.
      Parameters:
      value - The role name.

    • getName

      public String getName()
      The user-facing name of the security role assigned to the researcher. Must be unique.
      Returns:
      The role name.
      Since:
      2.19

    • setName

      public void setName(String name)
      Set the role name.
      Parameters:
      name - The role name.
      Since:
      2.19

    • getUri

      public URI getUri()
      Get the URI to the role.
      Returns:
      The URI.
      Since:
      2.19

    • setUri

      public void setUri(URI uri)
      Set the URI to the role.
      Parameters:
      uri - The URI.
      Since:
      2.19

    • getEntityClass

      public Class<Role> getEntityClass()
      Gets the entity class this link refers to.
      Returns:
      The Role class.

    • toString

      public String toString()
      Returns a string representation of this role link.
      Overrides:
      toString in class LimsLinkBase<Role>
      Returns:
      The role URI and name.
      See Also: