Module org.cruk.clarity.api
Package com.genologics.ri.researcher

Class Role

java.lang.Object
com.genologics.ri.researcher.Role
All Implemented Interfaces:
LimsLink<Role>, Linkable<Role>, Locatable, Serializable
public class Role extends Object implements LimsLink<Role>, Serializable
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

  • Constructor Details

    • Role

      public Role()

    • Role

      public Role(URI uri)

    • Role

      public Role(URI uri, String name)

    • Role

      public Role(Linkable<Role> link)

    • Role

      public Role(Role otherRole)

  • 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 researcher.
      Specified by:
      getUri in interface LimsLink<Role>
      Specified by:
      getUri in interface Locatable
      Returns:
      The URI.
      Since:
      2.19

    • setUri

      public void setUri(URI uri)
      Set the URI to the researcher.
      Specified by:
      setUri in interface Locatable
      Parameters:
      uri - The URI.
      Since:
      2.19

    • getEntityClass

      public Class<Role> getEntityClass()
      Description copied from interface: LimsLink
      Get the class of the true, full LIMS entity this object links to.
      Specified by:
      getEntityClass in interface LimsLink<Role>
      Returns:
      The real object class.

    • toString

      public String toString()
      Overrides:
      toString in class Object