/*
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 org.ovirt.engine.sdk4.services;

import java.io.IOException;
import org.ovirt.engine.sdk4.Request;
import org.ovirt.engine.sdk4.Response;
import org.ovirt.engine.sdk4.Service;
import org.ovirt.engine.sdk4.types.ClusterFeature;

/**
 * Represents a feature enabled for the cluster.
 */
public interface ClusterEnabledFeatureService extends Service {
    /**
     * Provides the information about the cluster feature enabled.
     * 
     * For example, to find details of the enabled feature `456` for cluster `123`, send a request like this:
     * 
     * [source]
     * ----
     * GET /ovirt-engine/api/clusters/123/enabledfeatures/456
     * ----
     * 
     * That will return a <<types/cluster_feature, ClusterFeature>> object containing the name:
     * 
     * [source,xml]
     * ----
     * <cluster_feature id="456">
     *   <name>libgfapi_supported</name>
     * </cluster_feature>
     * ----
     */
    public interface GetRequest extends Request<GetRequest, GetResponse> {
        /**
         * Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
         * of the current request. See <<documents/003_common_concepts/follow, here>> for details.
         */
        GetRequest follow(String follow);
    }
    
    /**
     * Provides the information about the cluster feature enabled.
     * 
     * For example, to find details of the enabled feature `456` for cluster `123`, send a request like this:
     * 
     * [source]
     * ----
     * GET /ovirt-engine/api/clusters/123/enabledfeatures/456
     * ----
     * 
     * That will return a <<types/cluster_feature, ClusterFeature>> object containing the name:
     * 
     * [source,xml]
     * ----
     * <cluster_feature id="456">
     *   <name>libgfapi_supported</name>
     * </cluster_feature>
     * ----
     */
    public interface GetResponse extends Response {
        /**
         * Retrieved cluster feature that's enabled.
         */
        ClusterFeature feature();
    }
    
    /**
     * Provides the information about the cluster feature enabled.
     * 
     * For example, to find details of the enabled feature `456` for cluster `123`, send a request like this:
     * 
     * [source]
     * ----
     * GET /ovirt-engine/api/clusters/123/enabledfeatures/456
     * ----
     * 
     * That will return a <<types/cluster_feature, ClusterFeature>> object containing the name:
     * 
     * [source,xml]
     * ----
     * <cluster_feature id="456">
     *   <name>libgfapi_supported</name>
     * </cluster_feature>
     * ----
     */
    GetRequest get();
    
    /**
     * Disables a cluster feature.
     * 
     * For example, to disable the feature `456` of cluster `123` send a request like this:
     * 
     * [source]
     * ----
     * DELETE /ovirt-engine/api/clusters/123/enabledfeatures/456
     * ----
     */
    public interface RemoveRequest extends Request<RemoveRequest, RemoveResponse> {
    }
    
    /**
     * Disables a cluster feature.
     * 
     * For example, to disable the feature `456` of cluster `123` send a request like this:
     * 
     * [source]
     * ----
     * DELETE /ovirt-engine/api/clusters/123/enabledfeatures/456
     * ----
     */
    public interface RemoveResponse extends Response {
    }
    
    /**
     * Disables a cluster feature.
     * 
     * For example, to disable the feature `456` of cluster `123` send a request like this:
     * 
     * [source]
     * ----
     * DELETE /ovirt-engine/api/clusters/123/enabledfeatures/456
     * ----
     */
    RemoveRequest remove();
    
    /**
     * Service locator method, returns individual service on which the URI is dispatched.
     */
    Service service(String path);
}

