it.tidalwave.netbeans.indexeddataobject.IndexedDataObjectManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of it-tidalwave-netbeans-indexeddataobject Show documentation

There is a newer version: 1.5.20

Show newest version

/***********************************************************************************************************************
 *
 * OpenBlueSky - NetBeans Platform Enhancements
 * Copyright (C) 2006-2012 by Tidalwave s.a.s. (http://www.tidalwave.it)
 *
 ***********************************************************************************************************************
 *
 * 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.
 *
 ***********************************************************************************************************************
 *
 * WWW: http://openbluesky.java.net
 * SCM: https://bitbucket.org/tidalwave/openbluesky-src
 *
 **********************************************************************************************************************/
package it.tidalwave.netbeans.indexeddataobject;

import javax.annotation.Nonnull;
import java.io.IOException;
import java.util.Collection;
import java.util.List;
import org.openide.loaders.DataObject;
import it.tidalwave.util.Id;

/***********************************************************************************************************************
 *
 * The IndexedDataObjectManager is a service which allows to bind
 * DataObjects with an unique id. This enables two operations:
 * retrieving the id from a DataObject and retrieving a
 * DataObject giving a its id.

 *
 * @author  Fabrizio Giudici
 * @version $Id$
 *
 **********************************************************************************************************************/
public interface IndexedDataObjectManager 
  {
    /***************************************************************************
     * 
     * Retrieves a DataObject given its id.
     * 
     * @param  id           the id
     * @return              the DataObject or null if no object is found
     * @throws IOException  if an error occurred 
     *
     **************************************************************************/
    public DataObject findById (@Nonnull Id id)
      throws IOException;
    
    // this optimizes batches
    public List findByIds (@Nonnull Collection ids);
  }