001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019
020package org.apache.isis.core.metamodel.facets.object.icon;
021
022import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
023import org.apache.isis.core.metamodel.facetapi.Facet;
024
025/*
026 * Icon for an object a class (for example, by placing an appropriately named image
027 * file into a certain directory). 
028 * 
029 * <p>
030 * The facet is checked each time the object is rendered, allowing the icon to be changed on an instance-by-instance basis. For
031 * example, the icon might be adapted with an overlay to represent its state through some well-defined lifecycle (eg
032 * pending approval, approved, rejected). Alternatively a {@link BoundedFacet bounded} class might have completely
033 * different icons for its instances (eg Visa, Mastercard, Amex).
034 * 
035 * <p>
036 * In the standard Apache Isis Programming Model, typically corresponds to a method named <tt>iconName</tt>.
037 * 
038 * @see TitleFacet
039 * @see PluralFacet
040 */
041public interface IconFacet extends Facet {
042
043    public String iconName(final ObjectAdapter object);
044}