org.eclipse.digitaltwin.aas4j.v3.model.ReferenceElement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of model Show documentation

This project includes a Java representation of the classes defined in the Asset Administration Shell ontology.

The newest version!

/*
 * Copyright (c) 2021 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e. V.
 * Copyright (c) 2023, SAP SE or an SAP affiliate company
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

package org.eclipse.digitaltwin.aas4j.v3.model;


import org.eclipse.digitaltwin.aas4j.v3.model.annotations.IRI;
import org.eclipse.digitaltwin.aas4j.v3.model.annotations.KnownSubtypes;
import org.eclipse.digitaltwin.aas4j.v3.model.impl.DefaultReferenceElement;


/**
 * A reference element is a data element that defines a logical reference to another element within
 * the same or another AAS or a reference to an external object or entity.
 */
@KnownSubtypes({
    @KnownSubtypes.Type(value = DefaultReferenceElement.class)
})
public interface ReferenceElement extends DataElement {

    /**
     * Global reference to an external object or entity or a logical reference to another element within
     * the same or another AAS (i.e. a model reference to a Referable).
     *
     * More information under https://admin-shell.io/aas/3/0/ReferenceElement/value
     *
     * @return Returns the Reference for the property value.
     */
    @IRI("https://admin-shell.io/aas/3/0/ReferenceElement/value")
    Reference getValue();

    /**
     * Global reference to an external object or entity or a logical reference to another element within
     * the same or another AAS (i.e. a model reference to a Referable).
     *
     * More information under https://admin-shell.io/aas/3/0/ReferenceElement/value
     *
     * @param value desired value for the property value.
     */
    void setValue(Reference value);

}