/*
 * ******************************************************************************
 *  * Copyright 2015 See AUTHORS file.
 *  *
 *  * 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 com.puremvc.core;

import com.puremvc.patterns.proxy.Proxy;

/**
 * The interface definition for a PureMVC Model.
 * <p>
 * <p>
 * In PureMVC, <code>Model</code> implementors provide access to
 * <code>Proxy</code> objects by named lookup.
 * </P>
 * <p>
 * <p>
 * An <code>Model</code> assumes these responsibilities:
 * </P>
 * <p>
 * <UL>
 * <LI>Maintain a cache of <code>Proxy</code> instances</LI>
 * <LI>Provide methods for registering, retrieving, and removing
 * <code>Proxy</code> instances</LI>
 * </UL>
 */
public interface Model {

    /**
     * Register an <code>Proxy</code> instance with the <code>Model</code>.
     *
     * @param proxy an object reference to be held by the <code>Model</code>.
     */
    void registerProxy(Proxy proxy);

    /**
     * Retrieve an <code>Proxy</code> instance from the Model.
     *
     * @param proxy
     * @return the <code>Proxy</code> instance previously registered with the
     * given <code>proxyName</code>.
     */
    <T extends Proxy> T retrieveProxy(String proxy);

    /**
     * Remove an <code>Proxy</code> instance from the Model.
     *
     * @param proxy name of the <code>Proxy</code> instance to be removed.
     */
    Proxy removeProxy(String proxy);

    /**
     * Check if a Proxy is registered
     *
     * @param proxyName
     * @return whether a Proxy is currently registered with the given <code>proxyName</code>.
     */
    boolean hasProxy(String proxyName);
}