/******************************************************************************
  @header FTSession
  @abstract FT sessions 
 
  @copyright 2004, 2005, 2006 Free Software Foundation, Inc.
  
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA

  <pre>
  -------------------------------------------------------------------------
  Modification history

  31.01.2005 ola     initial version
  23.08.2006 ola     license changed
  -------------------------------------------------------------------------
  </pre>
******************************************************************************/

#if !defined(__FTSESSION_H)
#define __FTSESSION_H

#include <Foundation/Foundation.h>
#include <FT/FTObject.h>
#include <FT/FTObjectToIdMapper.h>
#include <FT/FTGraphManager.h>
#include <FT/FTTransactionSettings.h>
#include <FT/FTTransaction.h>

/*!
 * @protocol FTSession
 */
@protocol FTSession <FTObject>

/*!
 * @method beginTransactionWithParent
 * @abstract Used to begin a transaction
 * @param parentTransaction may be nil. If not then the specified 
 *   transaction will be used as parent transaction and the new transaction
 *   will be executed as nested transaction. At present only nil values are 
 *   supported.
 * @param transactionSettings an instance specifying settings for this
 *   transaction. At present, only nil values are supported.
 * @result underlying transaction
 */
- (id <FTTransaction>) beginTransactionWithParent: 
  (id <FTTransaction>) parentTransaction
  withSettings: (id <FTTransactionSettings>) transactionSettings;
  
  
/*!
 * @method close
 * @abstract used to close this session.
 * @discussionion after calling this method the session instances may not be used
 *   any more.
 */
- close;


/*!
 * @method defaultObjectToIdMapper
 * @result return the default object to id mapper used e.g. to get id's 
 *   of graphs
 */
- (id <FTObjectToIdMapper>) defaultObjectToIdMapper;


/*!
 * @method graphManager
 * @result return the manager used to fetch, create etc. graphs
 */
- (id <FTGraphManager>) graphManager;


/*!
 * @method sessionId
 * @result return the id of this session
 */
- (id) sessionId;
@end

#endif
