---

MetadataPlugin.h

/*
   Copyright (C) 2002 the Strongroom project

   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.

   @author Wouter de Vries
   @author Ewald Snel
*/

#ifndef __METADATAPLUGIN_H
#define __METADATAPLUGIN_H

#include <pthread.h>
#include <map>

#include <Common.h>
#include <Document.h>
#include <Error.h>
#include <Plugin.h>

// Defines the type and scope of the document lock
enum DocumentLock
{
    LOCK_UNLOCK = 0,            // Unlocked
    LOCK_DOCUMENT,              // Exclusive lock on entire document
    LOCK_REVISION,              // Exclusive lock on (one) revision
    LOCK_RENDITION              // Exclusive lock on (one) rendition
};


using namespace std;

class MetadataPlugin : public Plugin
{
public:
    MetadataPlugin( const Config &cfg );
    virtual ~MetadataPlugin() = 0;

    virtual CoreError create( NumID &docid, const Document &document ) = 0;

    virtual CoreError remove( NumID docid ) = 0;

    virtual CoreError update( NumID docid, const Document &document ) = 0;

    virtual CoreError get( NumID docid, Document &document ) = 0;

    virtual CoreError lock( NumID docid, DocumentLock lock ) = 0;

    CoreError unlock( NumID docid );

    virtual CoreError getLocks( map<NumID,DocumentLock> &locks ) = 0;

    virtual CoreError query( NumID first, int maxlen, map<NumID,NumID> &updates ) = 0;
};

#endif

---