001/*
002 * (C) Copyright 2012 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Anahide Tchertchian
018 */
019package org.nuxeo.ecm.styleguide.service;
020
021import java.io.Serializable;
022import java.util.List;
023import java.util.Map;
024
025import javax.faces.context.ExternalContext;
026
027import org.nuxeo.ecm.styleguide.service.descriptors.IconDescriptor;
028
029/**
030 * @since 5.7
031 */
032public interface StyleGuideService extends Serializable {
033
034    /**
035     * Returns a map of all icons given a path, creating descriptors from them and putting all unknown icons in the
036     * "unknown" category.
037     */
038    Map<String, List<IconDescriptor>> getIconsByCat(ExternalContext cts, String path);
039
040}