history.h

/* history.h */
/* $Id: history.h,v 1.8 2003/02/14 16:20:09 vlad Exp $ */
#ifndef __history_h
#define __history_h

#include <mix/Types.h>
#include <ldb/dbtc.h>


/***********************************************************************
 *
 *                       Processing history API
 *
 ***********************************************************************/

/* Possible historical events that relate to data/jobs life inside the
   project during the data processing. */
typedef enum
{
  heNone = 0,       
  heMemo,       
  heStartJob,       
  heFinishJob,      
  heCreateData,     
  heModifyData,     
  heReadData,       
  heDeleteData,     
  heBackupData,     
  heRestoreData,    
  heImportData,     
  heExportData,     
  __heNumber        
}   HistoricalEvent;


typedef Int4    TimeStampId;


typedef struct{
  dbNameStruct name;
  TimeStampId iDeathDate;
  char sDate[MOMENT_LEN+1];
}   phDataObject;

typedef struct{
  int count;
  phDataObject* phdoList;  
  HistoricalEvent*pheList;
  HistoricalEvent pheEqual;
} phDataEvents;

typedef struct{
  char sAppName[WE_NAME_LEN+1]; 
  char sDate[MOMENT_LEN+1];
  char sUser[WE_NAME_LEN+1];
  int JobNumber;
} phJobObject;

typedef struct{
  int count;
  phJobObject* phjoList;  
  HistoricalEvent*pheList;
  HistoricalEvent pheEqual;
} phJobEvents;


typedef struct{
  char sDate[MOMENT_LEN+1];
} phDateEventQuery;


#define PH_EVENT_LEN        255


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


/***********************************************************************
 * Logging historical events.
 ***********************************************************************/

void        phAddRecord (const char* project,
                 HistoricalEvent event,
                 const dbNameStruct* dataref);

void        phAddMemo (const char* project,
               const char szMemo[PH_EVENT_LEN+1]);


/***********************************************************************
 * Toolkit for querying processing history.
 ***********************************************************************/

Logic       phGatherHistory (dbHandle dbh);


ErrCode phQueryEventsByData(const char* project, phDataObject phdo,
                phJobEvents* pOE);
ErrCode phQueryEventsByProg(const char* project, phJobObject  phjo,
                phDataEvents* pOE);
ErrCode phQueryEventsByDate(const char* project,
                phDateEventQuery dqFrom,phDateEventQuery dqTo,
                phJobEvents* pJE,phDataEvents* pDE);

ErrCode phExtractDataEvent(HistoricalEvent event,
               const phDataEvents* poeIn,phDataEvents*poeOut);
ErrCode phExtractJobEvent(HistoricalEvent event,
              const  phJobEvents* poeIn,phJobEvents*poeOut);

ErrCode phAppendJobEvents(phJobEvents* poeWhere,phJobEvents*poeWhat);
ErrCode phAppendDataEvents(phDataEvents* poeWhere,phDataEvents*poeWhat);

ErrCode phCopyDataObject(phDataObject* pTo,phDataObject* pFrom);
ErrCode phCopyJobObject(phJobObject* pTo,phJobObject* pFrom);

phJobEvents* newphJobEvents();

phDataEvents* newphDataEvents();

/***********************************************************************
 * Service and miscellaneous.
 ***********************************************************************/

const char* phEventToString (HistoricalEvent he);

HistoricalEvent phStringToEvent (const char* str);


/***********************************************************************
 * Common variables and constants.
 ***********************************************************************/

#ifndef __ProcHistVars

extern dbNameStruct dbnsHistory;

#endif /* __ProcHistVars */


#ifdef __cplusplus
};
#endif /* __cplusplus */

#endif /* history.h */