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

Go to download
/*
 * 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.protocol.StatusType;

/**
 * 
 * Interface describing the methods of the StatusBuilder.
 * Interface welches die Methoden des StatusBuilders beschreibt.
 * 
 * 
 * 
 */
public interface StatusBuilder extends SimpleBuilder {

	/**
	 * 
	 * Method to set the StatusCode of the Status to be build.
	 * Methode um ein StatusCode dem Status hinzuzufügen.
	 * 
	 * 
	 *
	 * @param aStatusCode
	 *  the StatusCode to be set
	 * 	der StatusCode der gesetzt werden soll
	 *  
	 *  
	 * @return
	 *  the actual instance of this builder
	 *  die aktuelle Instanz des Builders
	 *  
	 *  
	 * 
	 */
	StatusBuilder statusCode(StatusCode aStatusCode);

	/**
	 * 
	 * Method to set the StatusMessage of the Status to be build.
	 * Methode um eine StatusMessage dem Status hinzuzufügen.
	 * 
	 * 
	 *
	 * @param aStatusMessage
	 *  the StatusMessage to be set
	 * 	die StatusMessage der gesetzt werden soll
	 *  
	 *  
	 * @return
	 *  the actual instance of this builder
	 *  die aktuelle Instanz des Builders
	 *  
	 *  
	 * 
	 */
	StatusBuilder statusMessage(String aStatusMessage);

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

}