org.faktorips.runtime.IRuntimeObject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of faktorips-runtime Show documentation

Runtime library for Faktor-IPS. When using the JAXB support use either faktorips-runtime-jakarta-xml or faktorips-runtime-javax-xml as dependency. When using CSV to read tables, add the optional dependencies to opencsv, commons-lang3 and commons-text. If you want to run Faktor-IPS tests as JUnit tests, you need to provide either junit (JUnit 4) or junit-jupiter-api (JUnit 5).

There is a newer version: 25.1.0.a20241030-01

Show newest version

/*******************************************************************************
 * Copyright (c) Faktor Zehn GmbH - faktorzehn.org
 * 
 * This source code is available under the terms of the AGPL Affero General Public License version
 * 3.
 * 
 * Please see LICENSE.txt for full license terms, including the additional permissions and
 * restrictions as well as the possibility of alternative license terms.
 *******************************************************************************/

package org.faktorips.runtime;

import java.util.Set;

/**
 * Base class for runtime objects offering access to extension properties.
 * 
 * @author Daniel Hohenberger
 */
public interface IRuntimeObject {

    /**
     * @return a set of the extension property ids defined for this element.
     */
    Set getExtensionPropertyIds();

    /**
     * @param propertyId the id of the desired extension property.
     * 
     * @return the value of the extension property defined by the given propertyId or
     *             null if the extension property's isNull attribute is
     *             true.
     * @throws IllegalArgumentException if no such property exists.
     */
    Object getExtensionPropertyValue(String propertyId);

}