types.Role Maven / Gradle / Ivy

Go to download

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

Model management tools for the oVirt Engine API.

There is a newer version: 4.6.0

/*
Copyright (c) 2015 Red Hat, Inc.

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 types;

import org.ovirt.api.metamodel.annotations.Link;
import org.ovirt.api.metamodel.annotations.Type;

/**
 * Represents a system role.
 *
 * @author Irit Goihman 
 * @date 12 Dec 2016
 * @status added
 */
@Type
public interface Role extends Identified {
    /**
     * Defines the ability to update or delete the role.
     *
     * Roles with mutable set to `false` are predefined roles.
     *
     * @author Irit Goihman 
     * @date 12 Dec 2016
     * @status added
     */
    Boolean mutable();

    /**
     * Defines the role as administrative-only or not.
     *
     * @author Irit Goihman 
     * @date 12 Dec 2016
     * @status added
     */
    Boolean administrative();

    @Link User user();

    /**
     * A link to the permits sub-collection for role permits.
     *
     * @author Irit Goihman 
     * @date 12 Dec 2016
     * @status added
     */
    @Link Permit[] permits();
}