io.adminshell.aas.v3.model.Permission 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.
There is a newer version: 1.2.0
/*
 * Copyright (c) 2021 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e. V.
 *
 * 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 io.adminshell.aas.v3.model;




import io.adminshell.aas.v3.model.annotations.IRI;
import io.adminshell.aas.v3.model.annotations.KnownSubtypes;
import io.adminshell.aas.v3.model.builder.*;
import io.adminshell.aas.v3.model.impl.*;

/**
 * Description of a single permission.
 */
@KnownSubtypes({
    @KnownSubtypes.Type(value = DefaultPermission.class)
})
public interface Permission {

    /**
     * Description of the kind of permission. Possible kind of permission also include the denial of the
     * permission.
     *
     * More information under https://admin-shell.io/aas/3/0/RC01/Permission/kindOfPermission
     *
     * @return Returns the PermissionKind for the property kindOfPermission.
     */
    @IRI("https://admin-shell.io/aas/3/0/RC01/Permission/kindOfPermission")
    PermissionKind getKindOfPermission();

    /**
     * Description of the kind of permission. Possible kind of permission also include the denial of the
     * permission.
     *
     * More information under https://admin-shell.io/aas/3/0/RC01/Permission/kindOfPermission
     *
     * @param kindOfPermission desired value for the property kindOfPermission.
     */
    void setKindOfPermission(PermissionKind kindOfPermission);

    /**
     * Reference to a property that defines the semantics of the permission.
     *
     * Constraint AASs-010: The property referenced in Permission/permission shall have the category
     * 'CONSTANT'.
     *
     * Constraint AASs-011: The property referenced in Permission/permission shall be part of the
     * submodel that is referenced within the 'selectablePermissions' attribute of 'AccessControl'.
     *
     * More information under https://admin-shell.io/aas/3/0/RC01/Permission/permission
     *
     * @return Returns the Reference for the property permission.
     */
    @IRI("https://admin-shell.io/aas/3/0/RC01/Permission/permission")
    Reference getPermission();

    /**
     * Reference to a property that defines the semantics of the permission.
     *
     * Constraint AASs-010: The property referenced in Permission/permission shall have the category
     * 'CONSTANT'.
     *
     * Constraint AASs-011: The property referenced in Permission/permission shall be part of the
     * submodel that is referenced within the 'selectablePermissions' attribute of 'AccessControl'.
     *
     * More information under https://admin-shell.io/aas/3/0/RC01/Permission/permission
     *
     * @param permission desired value for the property permission.
     */
    void setPermission(Reference permission);

}