tapestry/tapestry-examples/Vlib/src/java/org/apache/tapestry/vlib/services/ModelSource.java

// Copyright 2005 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package org.apache.tapestry.vlib.services;

import org.apache.tapestry.form.IPropertySelectionModel;

/**
 * Source for some common Virtual Library property selection models.
 * 
 * @author Howard M. Lewis Ship
 * @since 4.0
 */
public interface ModelSource
{
    /**
     * Returns a model of the known Publishers, in alphabetical order.
     * 
     * @see org.apache.tapestry.vlib.ejb.IOperations#getPublishers()
     */
    IPropertySelectionModel getPublisherModel();

    /**
     * Returns a model of the known Users, in ascending alphbetical order (by last name).
     * 
     * @see org.apache.tapestry.vlib.ejb.IOperations#getPersons()
     */

    IPropertySelectionModel getPersonModel();

    /**
     * Returns a model of the known users, prefixed with an empty label option (used when selecting
     * a person is optional).
     */

    IPropertySelectionModel getOptionalPersonModel();

    /**
     * Clears all cached information; this is invoked after a change to the underlying person or
     * publisher data, or after any kind of exception accessing the backend.
     */

    void clear();
}