/*
 * Copyright (C) 2003-2011 eXo Platform SAS.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
package org.etk.storage.api;

import java.util.List;

import org.etk.service.foo.FooFilter;
import org.etk.service.foo.model.Bar;
import org.etk.service.foo.model.Foo;

/**
 * Created by The eXo Platform SAS
 * Author : eXoPlatform
 *          exo@exoplatform.com
 * Jul 22, 2011  
 */
public interface FooStorage {

  /**
   * Gets Foo by Id
   * @param id
   * @return
   */
  Foo findById(String id);
  
  /**
   * Gets the Foo list base on the FooFilter with offset and limit.
   * 
   * @param fooFilter
   * @param offset
   * @param limit
   * @return
   */
  List<Foo> getFooByFilter(FooFilter fooFilter, int offset, int limit);
  
  /**
   * Count the number of Foo with condition FooFilter.
   * @param fooFilter
   * @return
   */
  int getFooByFilterCount(final FooFilter fooFilter);

  /**
   * loads Bar from Foo
   * @param foo
   * @return
   */
  Bar loadBar(final Foo foo);
  
  
  /**
   * Creates the Foo data.
   * @param foo
   * @return
   */
  Foo saveFoo(final Foo foo);
  
  /**
   * Updates a Foo's information.
   * 
   * @param existingFoo
   * @return
   */
  Foo updateFoo(final Foo existingFoo);
  
  /**
   * Removes the existing Foo.
   * @param existingFoo
   */
  void deleteFoo(final Foo existingFoo);
}