source: ndgCommon/trunk/ndg/common/src/clients/interfacecrudclient.py @ 5008

'''
 Interface for clients extending search functionality to include standard CRUD
 (create, replace, update, delete) functionality for metadata documents
  
 @author: C Byrom - Tessella, Feb 09
'''
from interfacesearchclient import InterfaceSearchClient

class InterfaceCRUDClient(InterfaceSearchClient):

    def isNewDoc(self, docPath):
        '''
        Test if a doc already exists in the XML DB
        @param docPath: path of file to look up
        @return: True if a new doc, False if otherwise
        '''
        raise NotImplementedError("This is an interface class and this method has not " + \
                                  "been implemented yet")


    def backupDoc(self, collection, fileName, runAsynch = True):
        '''
        Backup a file that exists in the XML DB
        - NB, this really just creates a new file with the same contents in a 
        backup dir
        @param collection: path of the collection to store the file in
        @param fileName: name of file to add
        @param runAsynch: if True, do the backup asynchronously in a separate thread
        @return: path to new backup file
        '''
        raise NotImplementedError("This is an interface class and this method has not " + \
                                  "been implemented yet")


    def restoreBackup(self, docPath):
        '''
        Restore the backed up file - effectively recreating in the non-backup collection
        @param docPath: path to file to backup
        @param restoredFileName: path to newly restored file
        '''
        raise NotImplementedError("This is an interface class and this method has not " + \
                                  "been implemented yet")

    def createDoc(self, xml, collection, fileName):
        '''
        Add the input doc to the XML DB
        @param xml: contents of xml file to create in the XML DB
        @param collection: path of the collection to store the file in
        @param fileName: name of file to add
        @return: True, if file created successfully
        '''
        raise NotImplementedError("This is an interface class and this method has not " + \
                                  "been implemented yet")


    def deleteDoc(self, docPath):
        '''
        Delete the input file from the XML DB
        @param docPath: path of document to delete
        @return: True, if file deleted successfully
        '''
        raise NotImplementedError("This is an interface class and this method has not " + \
                                  "been implemented yet")


    def createOrUpdateDoc(self, xml, collection, fileName):
        '''
        Check if a file already exists in the XML DB; if it does, run an
        update (which will backup the existing file), otherwise create
        the file in eXist
        @param xml: contents of xml file to create/update in the XML DB
        @param collection: path of the collection to store the file in
        @param fileName: name of file to add
        @return name of backup file, if file needed to be backed up - or None, otherwise
        '''
        raise NotImplementedError("This is an interface class and this method has not " + \
                                  "been implemented yet")
        

    def isNewCollection(self, collectionPath):
        '''
        Look up a collection in using XPath
        @param collectionPath: path to collection to look up
        @return: False if collection exists, True otherwise
        '''
        raise NotImplementedError("This is an interface class and this method has not " + \
                                  "been implemented yet")

    def createCollections(self, collections):
        '''
        Create the specified collections in eXist
        @param collections: array of collections to create
        @return True if successful
        '''
        raise NotImplementedError("This is an interface class and this method has not " + \
                                  "been implemented yet")