empire-db-jsf2/src/main/java/org/apache/empire/jsf2/utils/ParameterObject.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.empire.jsf2.utils;

/**
 * ParameterObject
 * This interface is used to store objects in the session parameter map
 * The object must provide a unique instance key as a String
 * @author doebele
 */
public interface ParameterObject
{
    /**
     * provides the unique instance key for this object
     * @return the unique key
     */
    String getObjectKey();
}