org.projecthusky.xua.saml2.AssertionBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of husky-xua-gen-api Show documentation
There is a newer version: 2.5.2
/*
 * 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.saml2;

import org.openehealth.ipf.commons.ihe.xacml20.stub.saml20.assertion.AssertionType;
import org.openehealth.ipf.commons.ihe.xacml20.stub.saml20.assertion.AttributeType;
import org.openehealth.ipf.commons.ihe.xacml20.stub.saml20.assertion.ConditionsType;

/**
 * 
 * Interface describing the methods of the AssertionBuilder. 
 * Interface welches die Methoden des AssertionBuilders beschreibt.
 * 
 * 
 * 
 */
public interface AssertionBuilder extends BaseBuilder {

	/**
	 * 
	 * Method to add an Attribute to the assertion to be build.
	 * Methode um ein Attribute dem Assertion hinzuzufügen.
	 * 
	 * 
	 *
	 * @param aAttribute
	 * the Attribute to be added.
	 * das Attribute welches hinzugefügt werden soll.
	 * 
	 * 
	 * @return
	 * 	the actual instance of this builder
	 *  die aktuelle Instanz des Builders
	 *  
	 *  
	 * 
	 */
	AssertionBuilder addAttribute(AttributeType aAttribute);

	/**
	 * 
	 * Method to add a Condition to the assertion to be build.
	 * Methode um eine Condition der Assertion hinzuzufügen.
	 * 
	 * 
	 *
	 * @param aCondition
	 * the Condition to be added.
	 * die Condition welche hinzugefügt werden soll.
	 * 
	 * 
	 * @return
	 * 	the actual instance of this builder
	 *  die aktuelle Instanz des Builders
	 *  
	 *  
	 * 
	 */
	AssertionBuilder addCondition(ConditionsType aCondition);

	/**
	 * 
	 * Creates a concrete instance of Assertion with setted params.
	 * Erstellt die konkrete Instanz des Assertion mit den gesetzten Parametern.
	 * 
	 * 
	 *
	 * @return
	 *  a new Assertion instance with the params set
	 *  eine neue Assertion Instanz mit den gesetzten Parametern
	 *  
	 *  
	 *  
	 */
	Assertion create();

	/**
	 *
	 * 
	 * Method to create an instance of type AssertionType.
	 * Methode um eine Instanc des Typs AssertionType zu erstellen.
	 * 
	 * 
	 *
	 * @param aInternalObject
	 * the internal wrapped object of type AssertionType
	 * das Innere, gewrappte Object vom Typ AssertionType
	 * 
	 * 
	 * @return the Object ot the type Assertion
	 * the instance of type Assertion
	 * die erstellte Instanz vom Typ Assertion
	 * 
	 * 
	 *  
	 */
	Assertion create(AssertionType aInternalObject);

}