org.projecthusky.xua.communication.xua.XUserAssertionRequestBuilder Maven / Gradle / Ivy
/*
* This code is made available under the terms of the Eclipse Public License v1.0
* in the github project https://github.com/project-husky/husky there you also
* find a list of the contributors and the license information.
*
* This project has been developed further and modified by the joined working group Husky
* on the basis of the eHealth Connector opensource project from June 28, 2021,
* whereas medshare GmbH is the initial and main contributor/author of the eHealth Connector.
*
*/
package org.projecthusky.xua.communication.xua;
import org.projecthusky.xua.hl7v3.CE;
/**
*
* Interface describing the X-User assertion request builder methods.
* Interface welches die Methoden des X-User assertion builders beschreibt.
*
*
*
*/
public interface XUserAssertionRequestBuilder {
/**
*
* Method to set the AppliesTo attribute.
* Setzt das AppliesTo Attribut.
*
*
*
* @param appliesTo
* the value to be set
* der Wert der gesetzt werden soll
*
* der rolle der
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
XUserAssertionRequestBuilder appliesTo(AppliesTo appliesTo);
/**
*
*
* Method to set the context.
* Setzt den Kontext.
*
*
*
* @param aContext
* the context to be set
* der Kontext der gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
XUserAssertionRequestBuilder context(String aContext);
/**
*
* Creates a concrete instance of XUserAssertionRequest with setted params.
* Erstellt die konkrete Instanz des XUserAssertionRequest mit den gesetzten Parametern.
*
*
*
* @return
* a new XUserAssertionRequest instance with the params set
* eine neue XUserAssertionRequest Instanz mit den gesetzten Parametern
*
*
*
*/
XUserAssertionRequest create();
/**
*
*
* Method to set the dialect of the claims.
* Setzt den Dialekt des Claims.
*
*
*
* @param aDialect
* the dialect to be set
* den Dialekt der gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
XUserAssertionRequestBuilder dialect(String aDialect);
/**
*
*
* 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).
*
*
*
* @param organizationId
* the organisation id of the accessing person to be set
* die Organisations-ID der zugreifenden Person die gesetzt werden soll
*
* der rolle der
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
XUserAssertionRequestBuilder organizationId(String organizationId);
/**
*
*
* 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).
*
*
*
* @param 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
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
XUserAssertionRequestBuilder organizationName(String organizationName);
/**
*
*
* 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).
*
*
*
* @param aPurposeOfUse
* the purpose of user to be set
* der Grund des Zugriffes der gesetzt werden soll
*
* der rolle der
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
XUserAssertionRequestBuilder purposeOfUse(CE aPurposeOfUse);
/**
*
* Method to set the request type attribute.
* Setzt den Request Types Attribut.
*
*
*
* @param requestType
* the request type to be set
* der Request Typ der gesetzt werden soll
*
* der rolle der
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
XUserAssertionRequestBuilder requestType(RequestType requestType);
/**
*
*
* 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).
*
*
*
* @param resourceId
* the resource id to be set
* die ID der Ressource die gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
XUserAssertionRequestBuilder resourceId(String resourceId);
/**
*
*
* Method to set the ID of the accessor (GLN or EPR-SPID).
* Setzt die Zugreifer ID (GLN oder EPR-SPID).
*
*
*
* @param subjectId
* the id of the accessor to be set
* die ID der zugreifenden Person die gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
XUserAssertionRequestBuilder subjectId(String subjectId);
/**
*
*
* Method to set the name of the accessor (plain text of the user name)
* Setzt den Namen des Zugreifes (Klartext des Benutzernamens).
*
*
*
* @param subjectName
* the id of the accessor to be set
* die ID der zugreifenden Person die gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
XUserAssertionRequestBuilder subjectName(String subjectName);
/**
*
* 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)).
*
*
*
* @param roleId
* the id of the role to be set
* die ID der rolle der zugreifenden Person die gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
XUserAssertionRequestBuilder subjectRole(CE roleId);
/**
*
* Method to set the toke type attribute.
* Setzt den Token Types Attribut.
*
*
*
* @param tokenType
* the token type to be set
* der Token Typ der gesetzt werden soll
*
* der rolle der
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
XUserAssertionRequestBuilder tokenType(TokenType tokenType);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy