001// Copyright 2010-2013  The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007//     http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014package org.apache.tapestry5.services;
015
016import org.apache.tapestry5.SelectModel;
017
018import java.util.List;
019
020/**
021 * Used to create an {@link org.apache.tapestry5.SelectModel}.
022 * 
023 * @since 5.2.0
024 */
025public interface SelectModelFactory
026{
027    /**
028     * Creates a {@link org.apache.tapestry5.SelectModel} from a list of objects of the same type and a label property name.
029     * The returned model creates for every object in the list a selectable option and relies on existing 
030     * {@link org.apache.tapestry5.ValueEncoder} for the object type. The value of the label property is used as user-presentable label for the option.
031     * 
032     * @param objects objects to create model from
033     * @param labelProperty property for the client-side value
034     * @return the model
035     */
036    public SelectModel create(List<?> objects, String labelProperty);
037
038    /**
039     * Creates a {@link org.apache.tapestry5.SelectModel} from a list of objects of the same type.
040     * 
041     * The returned model creates for every object in the list a selectable option and relies on existing 
042     * {@link org.apache.tapestry5.ValueEncoder} for the object type.
043     * 
044     * @param objects objects to create model from
045     * @return the model
046     * 
047     * @since 5.4
048     */
049    public SelectModel create(List<?> objects);
050}