/*
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 java.math.BigInteger;
import java.util.List;
import org.ovirt.engine.sdk4.Request;
import org.ovirt.engine.sdk4.Response;
import org.ovirt.engine.sdk4.Service;
import org.ovirt.engine.sdk4.builders.QuotaBuilder;
import org.ovirt.engine.sdk4.types.Quota;

/**
 * Manages the set of quotas configured for a data center.
 */
public interface QuotasService extends Service {
    /**
     * Creates a new quota.
     * 
     * An example of creating a new quota:
     * 
     * [source]
     * ----
     * POST /ovirt-engine/api/datacenters/123/quotas
     * ----
     * 
     * [source,xml]
     * ----
     * <quota>
     *   <name>myquota</name>
     *   <description>My new quota for virtual machines</description>
     * </quota>
     * ----
     */
    public interface AddRequest extends Request<AddRequest, AddResponse> {
        AddRequest quota(Quota quota);
        AddRequest quota(QuotaBuilder quota);
    }
    
    /**
     * Creates a new quota.
     * 
     * An example of creating a new quota:
     * 
     * [source]
     * ----
     * POST /ovirt-engine/api/datacenters/123/quotas
     * ----
     * 
     * [source,xml]
     * ----
     * <quota>
     *   <name>myquota</name>
     *   <description>My new quota for virtual machines</description>
     * </quota>
     * ----
     */
    public interface AddResponse extends Response {
        Quota quota();
    }
    
    /**
     * Creates a new quota.
     * 
     * An example of creating a new quota:
     * 
     * [source]
     * ----
     * POST /ovirt-engine/api/datacenters/123/quotas
     * ----
     * 
     * [source,xml]
     * ----
     * <quota>
     *   <name>myquota</name>
     *   <description>My new quota for virtual machines</description>
     * </quota>
     * ----
     */
    AddRequest add();
    
    /**
     * Lists quotas of a data center.
     * 
     * The order of the returned list of quotas isn't guaranteed.
     */
    public interface ListRequest extends Request<ListRequest, ListResponse> {
        /**
         * Sets the maximum number of quota descriptors to return. If not specified all the descriptors are returned.
         */
        ListRequest max(Integer max);
        /**
         * Sets the maximum number of quota descriptors to return. If not specified all the descriptors are returned.
         */
        ListRequest max(Long max);
        /**
         * Sets the maximum number of quota descriptors to return. If not specified all the descriptors are returned.
         */
        ListRequest max(BigInteger max);
    }
    
    /**
     * Lists quotas of a data center.
     * 
     * The order of the returned list of quotas isn't guaranteed.
     */
    public interface ListResponse extends Response {
        List<Quota> quotas();
    }
    
    /**
     * Lists quotas of a data center.
     * 
     * The order of the returned list of quotas isn't guaranteed.
     */
    ListRequest list();
    
    QuotaService quotaService(String id);
    /**
     * Service locator method, returns individual service on which the URI is dispatched.
     */
    Service service(String path);
}

