/*
 * 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.exoplatform.social.extras.migration.rw;

import org.exoplatform.social.extras.migration.MigrationException;
import org.exoplatform.social.extras.migration.io.WriterContext;

import javax.jcr.RepositoryException;
import java.io.IOException;
import java.io.OutputStream;

/**
 * Read migraiton data.
 * @author <a href="mailto:alain.defrance@exoplatform.com">Alain Defrance</a>
 * @version $Revision$
 */
public interface NodeReader {

  /**
   *  Identities reading.
   * @param os data stream
   * @param ctx migration context
   */
  void readIdentities(OutputStream os, WriterContext ctx) throws RepositoryException, IOException;

  /**
   *  Spaces reading.
   * @param os data stream
   * @param ctx migration context
   */
  void readSpaces(OutputStream os, WriterContext ctx) throws RepositoryException, IOException;

  /**
   *  Profiles reading.
   * @param os data stream
   * @param ctx migration context
   */
  void readProfiles(OutputStream os, WriterContext ctx) throws RepositoryException, IOException;

  /**
   *  Activities reading.
   * @param os data stream
   * @param ctx migration context
   */
  void readActivities(OutputStream os, WriterContext ctx) throws RepositoryException, IOException;

  /**
   *  Relationships reading.
   * @param os data stream
   * @param ctx migration context
   */
  void readRelationships(OutputStream os, WriterContext ctx) throws RepositoryException, IOException;

  /**
   *  Check migration possibility.
   */
  void checkData() throws MigrationException;

}
