Package org.projecthusky.xua.communication.xua

Interface XUserAssertionRequestBuilder

All Known Implementing Classes:
XUserAssertionRequestBuilderChImpl, XUserAssertionRequestBuilderImpl
public interface XUserAssertionRequestBuilder
Interface describing the X-User assertion request builder methods.
Interface welches die Methoden des X-User assertion builders beschreibt.

  • Method Summary

    Modifier and Type
    Method
    Description
    XUserAssertionRequestBuilder
    appliesTo(AppliesTo appliesTo)
    Method to set the AppliesTo attribute. Setzt das AppliesTo Attribut.
    XUserAssertionRequestBuilder
    context(String aContext)
    Method to set the context. Setzt den Kontext.
    XUserAssertionRequest
    create()
    Creates a concrete instance of XUserAssertionRequest with setted params. Erstellt die konkrete Instanz des XUserAssertionRequest mit den gesetzten Parametern.
    XUserAssertionRequestBuilder
    dialect(String aDialect)
    Method to set the dialect of the claims. Setzt den Dialekt des Claims.
    XUserAssertionRequestBuilder
    organizationId(String organizationId)
    Method to set the id of the organisation of the accessing person (GLN of an organisation or a group from the HOI). Setzt die Organisations-ID des Zugreifers (GLN einer Organisation oder einer Gruppe aus dem HOI).
    XUserAssertionRequestBuilder
    organizationName(String organizationName)
    Method to set the name of the organisation of the accessing person (plain text of the organisation). Setzt den Organisationsnamen des Zugreifers (Klartext des Organisationsnamens).
    XUserAssertionRequestBuilder
    purposeOfUse(CE aPurposeOfUse)
    Method to set the reason of access in the actual application context (for the EPR in Switzerland: Code from the Swiss value set: normal access, emergency access). Setzt den Grund für den Zugriff im aktuellen Applikationskontext (für das EPD in der Schweiz: Code aus dem schweizerischen Value-Set: Normalzugriff, Notfallzugriff).
    XUserAssertionRequestBuilder
    requestType(RequestType requestType)
    Method to set the request type attribute. Setzt den Request Types Attribut.
    XUserAssertionRequestBuilder
    resourceId(String resourceId)
    Method to set the resource id of the actual application context of the transaction (for the EPR in Switzerland: EPR-SPID of the desired patient record). Setzt die Ressourcen-ID im aktuellen Applikationskontext auf welche sich die Transaktion bezieht (für das EPD in der Schweiz: EPR-SPID des gewünschten Patienten-Dossiers).
    XUserAssertionRequestBuilder
    subjectId(String subjectId)
    Method to set the ID of the accessor (GLN or EPR-SPID). Setzt die Zugreifer ID (GLN oder EPR-SPID).
    XUserAssertionRequestBuilder
    subjectName(String subjectName)
    Method to set the name of the accessor (plain text of the user name) Setzt den Namen des Zugreifes (Klartext des Benutzernamens).
    XUserAssertionRequestBuilder
    subjectRole(CE roleId)
    Method to set role id of the accessor in the actual application context (for the EPR in Switzerland: Code from the Swiss Value Set for the role: patient, health professional, assistant, deputy). Setzt die ID der Rolle des Zugreifers im aktuellen Applikationskontext (für das EPD in der Schweiz: Code aus dem schweizerischen Value-Set für die Rolle: Patient(in), Behandelnde(r), Hilfsperson, Stellvertreter(in)).
    XUserAssertionRequestBuilder
    tokenType(TokenType tokenType)
    Method to set the toke type attribute. Setzt den Token Types Attribut.

  • Method Details

    • appliesTo

      XUserAssertionRequestBuilder appliesTo(AppliesTo appliesTo)
      Method to set the AppliesTo attribute.
      Setzt das AppliesTo Attribut.
      Parameters:
      appliesTo -
      the value to be set
      der Wert der gesetzt werden soll
      der rolle der
      Returns:
      the actual instance of this builder
      die aktuelle Instanz des Builders

    • context

      XUserAssertionRequestBuilder context(String aContext)
      Method to set the context.
      Setzt den Kontext.
      Parameters:
      aContext -
      the context to be set
      der Kontext der gesetzt werden soll
      Returns:
      the actual instance of this builder
      die aktuelle Instanz des Builders

    • create

      XUserAssertionRequest create()
      Creates a concrete instance of XUserAssertionRequest with setted params.
      Erstellt die konkrete Instanz des XUserAssertionRequest mit den gesetzten Parametern.
      Returns:
      a new XUserAssertionRequest instance with the params set
      eine neue XUserAssertionRequest Instanz mit den gesetzten Parametern

    • dialect

      XUserAssertionRequestBuilder dialect(String aDialect)
      Method to set the dialect of the claims.
      Setzt den Dialekt des Claims.
      Parameters:
      aDialect -
      the dialect to be set
      den Dialekt der gesetzt werden soll
      Returns:
      the actual instance of this builder
      die aktuelle Instanz des Builders

    • organizationId

      XUserAssertionRequestBuilder organizationId(String organizationId)
      Method to set the id of the organisation of the accessing person (GLN of an organisation or a group from the HOI).
      Setzt die Organisations-ID des Zugreifers (GLN einer Organisation oder einer Gruppe aus dem HOI).
      Parameters:
      organizationId -
      the organisation id of the accessing person to be set
      die Organisations-ID der zugreifenden Person die gesetzt werden soll
      der rolle der
      Returns:
      the actual instance of this builder
      die aktuelle Instanz des Builders

    • organizationName

      XUserAssertionRequestBuilder organizationName(String organizationName)
      Method to set the name of the organisation of the accessing person (plain text of the organisation).
      Setzt den Organisationsnamen des Zugreifers (Klartext des Organisationsnamens).
      Parameters:
      organizationName -
      the organisation name of the accessing person to be set
      der Name der Organisation der zugreifenden Person die gesetzt werden soll
      der rolle der
      Returns:
      the actual instance of this builder
      die aktuelle Instanz des Builders

    • purposeOfUse

      XUserAssertionRequestBuilder purposeOfUse(CE aPurposeOfUse)
      Method to set the reason of access in the actual application context (for the EPR in Switzerland: Code from the Swiss value set: normal access, emergency access).
      Setzt den Grund für den Zugriff im aktuellen Applikationskontext (für das EPD in der Schweiz: Code aus dem schweizerischen Value-Set: Normalzugriff, Notfallzugriff).
      Parameters:
      aPurposeOfUse -
      the purpose of user to be set
      der Grund des Zugriffes der gesetzt werden soll
      der rolle der
      Returns:
      the actual instance of this builder
      die aktuelle Instanz des Builders

    • requestType

      XUserAssertionRequestBuilder requestType(RequestType requestType)
      Method to set the request type attribute.
      Setzt den Request Types Attribut.
      Parameters:
      requestType -
      the request type to be set
      der Request Typ der gesetzt werden soll
      der rolle der
      Returns:
      the actual instance of this builder
      die aktuelle Instanz des Builders

    • resourceId

      XUserAssertionRequestBuilder resourceId(String resourceId)
      Method to set the resource id of the actual application context of the transaction (for the EPR in Switzerland: EPR-SPID of the desired patient record).
      Setzt die Ressourcen-ID im aktuellen Applikationskontext auf welche sich die Transaktion bezieht (für das EPD in der Schweiz: EPR-SPID des gewünschten Patienten-Dossiers).
      Parameters:
      resourceId -
      the resource id to be set
      die ID der Ressource die gesetzt werden soll
      Returns:
      the actual instance of this builder
      die aktuelle Instanz des Builders

    • subjectId

      XUserAssertionRequestBuilder subjectId(String subjectId)
      Method to set the ID of the accessor (GLN or EPR-SPID).
      Setzt die Zugreifer ID (GLN oder EPR-SPID).
      Parameters:
      subjectId -
      the id of the accessor to be set
      die ID der zugreifenden Person die gesetzt werden soll
      Returns:
      the actual instance of this builder
      die aktuelle Instanz des Builders

    • subjectName

      XUserAssertionRequestBuilder subjectName(String subjectName)
      Method to set the name of the accessor (plain text of the user name)
      Setzt den Namen des Zugreifes (Klartext des Benutzernamens).
      Parameters:
      subjectName -
      the id of the accessor to be set
      die ID der zugreifenden Person die gesetzt werden soll
      Returns:
      the actual instance of this builder
      die aktuelle Instanz des Builders

    • subjectRole

      XUserAssertionRequestBuilder subjectRole(CE roleId)
      Method to set role id of the accessor in the actual application context (for the EPR in Switzerland: Code from the Swiss Value Set for the role: patient, health professional, assistant, deputy).
      Setzt die ID der Rolle des Zugreifers im aktuellen Applikationskontext (für das EPD in der Schweiz: Code aus dem schweizerischen Value-Set für die Rolle: Patient(in), Behandelnde(r), Hilfsperson, Stellvertreter(in)).
      Parameters:
      roleId -
      the id of the role to be set
      die ID der rolle der zugreifenden Person die gesetzt werden soll
      Returns:
      the actual instance of this builder
      die aktuelle Instanz des Builders

    • tokenType

      XUserAssertionRequestBuilder tokenType(TokenType tokenType)
      Method to set the toke type attribute.
      Setzt den Token Types Attribut.
      Parameters:
      tokenType -
      the token type to be set
      der Token Typ der gesetzt werden soll
      der rolle der
      Returns:
      the actual instance of this builder
      die aktuelle Instanz des Builders