/**
 * Copyright (C) 2012-2013 Selventa, Inc.
 *
 * This file is part of the OpenBEL Framework.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * The OpenBEL Framework is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with the OpenBEL Framework. If not, see <http://www.gnu.org/licenses/>.
 *
 * Additional Terms under LGPL v3:
 *
 * This license does not authorize you and you are prohibited from using the
 * name, trademarks, service marks, logos or similar indicia of Selventa, Inc.,
 * or, in the discretion of other licensors or authors of the program, the
 * name, trademarks, service marks, logos or similar indicia of such authors or
 * licensors, in any marketing or advertising materials relating to your
 * distribution of the program or any covered product. This restriction does
 * not waive or limit your obligation to keep intact all copyright notices set
 * forth in the program as delivered to you.
 *
 * If you distribute the program in whole or in part, or any modified version
 * of the program, and you assume contractual liability to the recipient with
 * respect to the program or modified version, then you will indemnify the
 * authors and licensors of the program for any liabilities that these
 * contractual assumptions directly impose on those licensors and authors.
 */
package org.openbel.framework.core.df.cache;

import java.util.List;

import org.openbel.framework.common.InvalidArgument;
import org.openbel.framework.common.cfg.SystemConfiguration;

/**
 * CacheLookupService defines service-level lookup operations to the
 * BELFramework cache defined at {@link SystemConfiguration#getCacheDirectory()}.
 *
 * @author Anthony Bargnesi {@code <abargnesi@selventa.com>}
 */
public interface CacheLookupService {

    /**
     * Defines the default file name to represent the cached resource - {@value}.
     */
    public final static String DEFAULT_RESOURCE_FILE_NAME = "resource";

    /**
     * Retrieves the cached resource for the location.
     *
     * @param resourceType {@link ResourceType}, the resource type of the
     * <tt>location</tt> provided, which cannot be null
     * @param location {@link String}, the remote resource location, which
     * cannot be null
     * @return {@link CachedResource} the cache entry for the resource
     * location or <tt>null</tt> if the resource is not in the cache
     * @throws InvalidArgument Thrown if the <tt>location</tt> or
     * <tt>resourceType</tt> is null
     */
    public CachedResource
            findInCache(ResourceType resourceType, String location);

    /**
     * Retrieves all resources that are present in the cache.
     *
     * @return {@link List} of {@link CachedResource}, the list of resources
     * present in the cache, which might be empty
     */
    public List<CachedResource> getResources();
}