/*
 * Copyright (C) 2014 Red Hat, Inc.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */

package org.opendaylight.neutron.spi;

import java.util.List;

/**
 * This interface defines the methods for CRUD of NB OpenStack LoadBalancerPool objects
 *
 */

public interface INeutronLoadBalancerPoolCRUD
    extends INeutronCRUD<NeutronLoadBalancerPool> {
    /**
     * Applications call this interface method to determine if a particular
     *LoadBalancerPool object exists
     *
     * @param uuid
     *            UUID of the LoadBalancerPool object
     * @return boolean
     */

    boolean neutronLoadBalancerPoolExists(String uuid);

    /**
     * Applications call this interface method to return if a particular
     * LoadBalancerPool object exists
     *
     * @param uuid
     *            UUID of the LoadBalancerPool object
     * @return {@link NeutronLoadBalancerPool}
     *          OpenStackLoadBalancerPool class
     */

    NeutronLoadBalancerPool getNeutronLoadBalancerPool(String uuid);

    /**
     * Applications call this interface method to return all LoadBalancerPool objects
     *
     * @return List of OpenStackNetworks objects
     */

    List<NeutronLoadBalancerPool> getAllNeutronLoadBalancerPools();

    /**
     * Applications call this interface method to add a LoadBalancerPool object to the
     * concurrent map
     *
     * @param input
     *            OpenStackNetwork object
     * @return boolean on whether the object was added or not
     */

    boolean addNeutronLoadBalancerPool(NeutronLoadBalancerPool input);

    /**
     * Applications call this interface method to remove a Neutron LoadBalancerPool object to the
     * concurrent map
     *
     * @param uuid
     *            identifier for the LoadBalancerPool object
     * @return boolean on whether the object was removed or not
     */

    boolean removeNeutronLoadBalancerPool(String uuid);

    /**
     * Applications call this interface method to edit a LoadBalancerPool object
     *
     * @param uuid
     *            identifier of the LoadBalancerPool object
     * @param delta
     *            OpenStackLoadBalancerPool object containing changes to apply
     * @return boolean on whether the object was updated or not
     */

    boolean updateNeutronLoadBalancerPool(String uuid, NeutronLoadBalancerPool delta);

    /**
     * Applications call this interface method to see if a MAC address is in use
     *
     * @param uuid
     *            identifier of the LoadBalancerPool object
     * @return boolean on whether the macAddress is already associated with a
     * port or not
     */

    boolean neutronLoadBalancerPoolInUse(String uuid);

    /**
     * Applications call this interface method to determine if a particular
     *NeutronLoadBalancerPoolMember object exists
     *
     * @param poolUuid
     *            UUID of the NeutronLoadBalancerPool object
     * @param uuid
     *            UUID of the NeutronLoadBalancerPoolMember object
     * @return boolean
     */

    boolean neutronLoadBalancerPoolMemberExists(String poolUuid, String uuid);

    /**
     * Applications call this interface method to return if a particular
     * NeutronLoadBalancerPoolMember object exists
     *
     * @param poolUuid
     *            UUID of the NeutronLoadBalancerPool object
     * @param uuid
     *            UUID of the NeutronLoadBalancerPoolMember object
     * @return {@link org.opendaylight.neutron.spi.NeutronLoadBalancerPoolMember}
     *          OpenStackNeutronLoadBalancerPoolMember class
     */

    NeutronLoadBalancerPoolMember getNeutronLoadBalancerPoolMember(String poolUuid, String uuid);

    /**
     * Applications call this interface method to return all NeutronLoadBalancerPoolMember objects
     *
     * @param poolUuid
     *            UUID of the NeutronLoadBalancerPool object
     * @return List of OpenStackNetworks objects
     */

    List<NeutronLoadBalancerPoolMember> getAllNeutronLoadBalancerPoolMembers(String poolUuid);

    /**
     * Applications call this interface method to add a NeutronLoadBalancerPoolMember object to the
     * concurrent map
     *
     * @param poolUuid
     *            UUID of the NeutronLoadBalancerPool object
     * @param input
     *            OpenStackNetwork object
     * @return boolean on whether the object was added or not
     */

    boolean addNeutronLoadBalancerPoolMember(String poolUuid, NeutronLoadBalancerPoolMember input);

    /**
     * Applications call this interface method to remove a Neutron NeutronLoadBalancerPoolMember object to the
     * concurrent map
     *
     * @param poolUuid
     *            UUID of the NeutronLoadBalancerPool object
     * @param uuid
     *            identifier for the NeutronLoadBalancerPoolMember object
     * @return boolean on whether the object was removed or not
     */

    boolean removeNeutronLoadBalancerPoolMember(String poolUuid, String uuid);

    /**
     * Applications call this interface method to edit a NeutronLoadBalancerPoolMember object
     *
     * @param poolUuid
     *            identifier of the NeutronLoadBalancerPool object
     * @param uuid
     *            identifier of the NeutronLoadBalancerPoolMember object
     * @param delta
     *            OpenStackNeutronLoadBalancerPoolMember object containing changes to apply
     * @return boolean on whether the object was updated or not
     */

    boolean updateNeutronLoadBalancerPoolMember(String poolUuid, String uuid, NeutronLoadBalancerPoolMember delta);

    /**
     * Applications call this interface method to see if a MAC address is in use
     *
     * @param poolUuid
     *            identifier of the NeutronLoadBalancerPool object
     * @param uuid
     *            identifier of the NeutronLoadBalancerPoolMember object
     * @return boolean on whether the macAddress is already associated with a
     * port or not
     */

    boolean neutronLoadBalancerPoolMemberInUse(String poolUuid, String uuid);
}