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.properties.searchable;
021
022import org.apache.isis.core.metamodel.facets.MultipleValueFacet;
023
024/**
025 * Indicates that this property should be used as part of a generic searching
026 * capability (for example, query by example).
027 * 
028 * <p>
029 * In the standard Apache Isis Programming Model, corresponds to annotating the
030 * property with the <tt>@Searchable</tt> annotation.
031 * 
032 * <p>
033 * TODO: not yet implemented by the framework or any viewer. Originally
034 * introduced for the adapterrcp.sourceforge.net viewer as an extension point
035 * plug-in for the Search menu ( <tt>org.eclipse.search.searchPages</tt>).
036 */
037public interface SearchableFacet extends MultipleValueFacet {
038
039    /**
040     * The (class of the) repository to delegate to.
041     */
042    public Class<?> repository();
043
044    /**
045     * Whether this is a query by example search.
046     */
047    public boolean queryByExample();
048
049}