StDataException.h

/*
 * @file StDataException.h
 * @author Stephen Tramer
 *
 * @(#)cpp/api:$Id: StDataException.h,v 1.2 2010/03/30 20:05:36 fine Exp $
 *
 * StDataException is the most generic exception class thrown by the base
 * part of the data tier (and is so named because the base part of the library
 * represents all data abstractions).  It modifies provided descriptions
 * to include additional information by prepending "[DATA:$type]", where
 * $type indicates the type of data for where the exception occured.
 */
 
#ifndef _TX_DATA_EXCEPTION_H_
#define _TX_DATA_EXCEPTION_H_

#include <string>
#include "StUCMException.h"

class StDataException : public StUCMException {
 public:
  enum ObjectType {
    STORE,
    COLLECTION,
    RECORD,
    FIELD
  };

 public:
  StDataException( const std::string& description,
                   ObjectType object,
                   StUCMException::Severity severity = StUCMException::ERROR);

  virtual ~StDataException();


  ObjectType getObjectType() const;

 private:
  std::string typeToString() const;

 private:
  ObjectType object_;
};

#endif