/*
 * Copyright 2015 Real Logic Ltd.
 *
 * 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 amaethon;

import java.util.function.Consumer;

/**
 * Interface for an Auction House
 */
public interface Model
{
    // add an auction
    int add(final byte[] name, final int nameLength, final long expiration, final long reserveValue);

    // cancel an auction
    void cancel(final int auctionId);

    // bid on an auction. True if high bid, False if not
    boolean bid(final int auctionId, final long bidderId, final long value);

    // iterator over all non-inactive auctions (for activity feed and for advancing time on auctions)
    void forEach(final Consumer<Auction> consumer);

    // done to add a new bidding account to the system
    void addBidder(final byte[] name, final long bidderId, final long budget);
}