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.choices;
021
022import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
023import org.apache.isis.core.metamodel.facetapi.Facet;
024import org.apache.isis.core.metamodel.spec.SpecificationLoader;
025
026/**
027 * Provides a set of choices for a property.
028 * 
029 * <p>
030 * Viewers would typically represent this as a drop-down list box for the
031 * property.
032 * 
033 * <p>
034 * In the standard Apache Isis Programming Model, corresponds to the
035 * <tt>choicesXxx</tt> supporting method for the property with accessor
036 * <tt>getXxx</tt>.
037 * 
038 * <p>
039 * Note: an alternative mechanism may be to use the <tt>@Bounded</tt> annotation
040 * against the referenced class.
041 */
042public interface PropertyChoicesFacet extends Facet {
043
044    /**
045     * Gets the available choices for this property.
046     */
047    public Object[] getChoices(ObjectAdapter adapter, SpecificationLoader specificationLookup);
048}