de.ehex.foss.gematik.specifications.PTStB Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gematik-specifications Show documentation

This project provides the eHealthExperts-related, commonly used gematik specifications (AFOs, Specs, PTStBs, etc.).

There is a newer version: 2.5.2

Show newest version

package de.ehex.foss.gematik.specifications;

import java.util.Set;

/**
 * API definition of a gematik Produtktypsteckbrief (abbr. PTStB, engl. product type characteristics).
 *
 * In detail, a PTStB is a special specification because it does not originally specify some {@link AFO}s but references
 * all relevant ones.
 *
 * @author Stefan Gasterstädt
 * @since September 21st, 2016
 */
public abstract interface PTStB extends TestableSpecification {

    /**
     * Returns the reference label of {@code this} PTStB.
     *
     * Usually, this field can be derive from the cover of the gematik PTStB (most probably identified by
     * Referenzierung).
     *
     * @return the reference label of {@code this} PTStB
     */
    @Override /* to update the javadoc */
    public abstract String getReference();

    /**
     * Returns a {@linkplain Set set} of all {@link AFO}s referenced by {@code this} PTStB.
     *
     * @return a set of all AFOs referenced by {@code this} PTStB
     */
    @Override /* to update the javadoc */
    public abstract Set getAFOs();

    /**
     * Returns a {@linkplain Set set} of all {@link AFO}s referenced by {@code this} PTStB that have to be tested by
     * manufacturers on its own responsibility.
     *
     * Any implementation must ensure the sub-set relation of this method's result in relation to {@link #getAFOs()}.
     */
    @Override /* to update the javadoc */
    public abstract Set getTestableAFOs();

}