org.apache.myfaces.trinidadinternal.ui.data.MutableDataObject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of trinidad-impl Show documentation

Private implementation of the Apache MyFaces Trinidad project

The newest version!

/*
 *  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.myfaces.trinidadinternal.ui.data;

import org.apache.myfaces.trinidadinternal.ui.UIXRenderingContext;

/**
 * The MutableDataObject interface provides an extremely simple API for
 * modifying arbitrarily structured data.  All "updates"
 * are based simply on a selection string.  It is entirely up to an
 * implementation of this interface to define the syntax for these
 * strings.
 * 
 * @version $Name:  $ ($Revision: adfrt/faces/adf-faces-impl/src/main/java/oracle/adfinternal/view/faces/ui/data/MutableDataObject.java#0 $) $Date: 10-nov-2005.18:56:34 $
 * @deprecated This class comes from the old Java 1.2 UIX codebase and should not be used anymore.
 */
@Deprecated
public interface MutableDataObject extends DataObject
{
  /**
   * Given a select string, updates the value matching that
   * selection.
   * 
   * @param context the current rendering context
   * @param select a select criterion, syntax as defined by the data object
   * @param value  the new value associated with this select criterion
   */
  public void updateValue(UIXRenderingContext context, 
                          Object select, 
                          Object value);
}