com.sencha.gxt.legacy.client.data.ModelData Maven / Gradle / Ivy

Go to download
/**
 * Sencha GXT 3.1.1 - Sencha for GWT
 * Copyright(c) 2007-2014, Sencha, Inc.
 * [email protected]
 *
 * http://www.sencha.com/products/gxt/license/
 */
package com.sencha.gxt.legacy.client.data;

import java.util.Collection;
import java.util.Map;

public interface ModelData {

  /**
   * Returns the named property from this model instance.
   * 
   * @param property the property name
   * @return the value
   */
  public  X get(String property);

  /**
   * Returns the model's properties and values as a map.
   * 
   * 
   * Changes to the returned collection should not mutate this model instance.
   * 
   * @return the properties and values
   */
  public Map getProperties();

  /**
   * Returns an collection of the model's property names.
   * 
   * 

   * The collection should be a snapshot of the property names that the model
   * represents.
   * 
   * 
   * Changes to the returned collection should not mutate this model instance.
   */
  public Collection getPropertyNames();

  /**
   * Removes the named property from this model instance.
   * 
   * @param property the property name
   * @return the old value for the property
   */
  public  X remove(String property);

  /**
   * Sets a property.
   * 
   * @param property the property name
   * @param value property value
   * @return the old value for the property
   */
  public  X set(String property, X value);
}