services.PermitsService 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 services;

import annotations.Area;
import org.ovirt.api.metamodel.annotations.In;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;
import types.Permit;

@Service
@Area("Infrastructure")
public interface PermitsService {
    /**
     * Adds a permit to the set aggregated by parent role. The permit must be one retrieved from the capabilities
     * resource.
     */
    interface Add {
        /**
         * The permit to add.
         */
        @In @Out Permit permit();

    }

    interface List {
        @Out Permit[] permits();

        /**
         * Sets the maximum number of permits to return. If not specified all the permits are returned.
         */
        @In Integer max();
    }

    /**
     * Sub-resource locator method, returns individual permit resource on which the remainder of the URI is dispatched.
     */
    @Service PermitService permit(String id);
}