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.facets;
021
022import org.apache.isis.applib.annotation.Facets;
023import org.apache.isis.core.metamodel.facetapi.Facet;
024import org.apache.isis.core.metamodel.facets.FacetFactory;
025import org.apache.isis.core.metamodel.facets.MultipleValueFacet;
026
027/**
028 * Indicates that this class has additional arbitrary facets, to be processed.
029 * 
030 * <p>
031 * Corresponds to the {@link Facets} annotation in the applib.
032 * 
033 * <p>
034 * <i>This</i> {@link Facet} allows the {@link FacetFactory}(s) that will create
035 * those {@link Facet}s to be accessed. Which, admittedly, is rather confusing.
036 */
037public interface FacetsFacet extends MultipleValueFacet {
038
039    /**
040     * Returns the fully qualified class of the facet factory, which should be
041     * {@link Class#isAssignableFrom(Class)} {@link FacetFactory}.
042     * 
043     * <p>
044     * Includes both the named facet factories and those identified directly by
045     * class. However, all are guaranteed to implement {@link FacetFactory}.
046     */
047    public Class<? extends FacetFactory>[] facetFactories();
048}