InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IDBErrorInfo.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Roey Horns
6 //
7 // $Author$
8 //
9 // $DateTime$
10 //
11 // $Revision$
12 //
13 // $Change$
14 //
15 // Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
16 //
17 // NOTICE: Adobe permits you to use, modify, and distribute this file in accordance
18 // with the terms of the Adobe license agreement accompanying it. If you have received
19 // this file from a source other than Adobe, then your use, modification, or
20 // distribution of it requires the prior written permission of Adobe.
21 //
22 //========================================================================================
23 
24 #ifndef __IDBERRORINFO__
25 #define __IDBERRORINFO__
26 
27 #include "IPMUnknown.h"
28 #include "IDataBase.h"
29 #include <map>
30 
31 class IDocument;
32 
38 class IDBErrorInfo : public IPMUnknown
39 {
40 public:
41  virtual void SetInfo(IDataBase::DBResultCode err) = 0;
42  virtual void SetInfo(IDataBase* db) = 0;
43  virtual void SetInfo(IDocument* doc) = 0;
44  virtual void SetInfo(const IDFile &file) = 0;
45 
46  virtual IDataBase::DBResultCode GetDBResultCode() = 0;
47 
48  virtual PMString GetDocName() = 0;
49  virtual PMString GetShortDescription(ErrorCode userErrorCode, const std::string* logString = nullptr) = 0;
50 
51  // Internal use only APIs
52  typedef std::map<std::string, std::string> DBErrorsLoggingMap;
53  virtual void FetchAndLogDetailedDBError(ErrorCode userErrorCode, IDBErrorInfo::DBErrorsLoggingMap& dbErrorParams, std::string& docIDStr, const std::string* logString) = 0;
54  virtual IDFile GetDocIDFile() const = 0;
55  virtual IDataBase* GetDataBase() const = 0;
56 };
57 
58 
59 #endif // __IDBERRORINFO__