#include <SFBPimRecordStore.h.hpp>

class SFBPimRecordStore : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBPimRecordStore)

[ public ]
SFCError AddRecord(
    UInt08ConstPtr entry   // the record to be added to the record store specified as a sequence of octets (8-bit bytes)
    SInt32 length          // the number of the elements in Entry
    RecordIDPtr id         // on success, the unique record identifier for the record that was added to the record store
);

[ public ]
SFCError AddRecord(
    SFXBufferConstRef entry   // the record to be added to the record store specified as a sequence of octets (8-bit bytes)
    RecordIDPtr id            // on success, the unique record identifier for the record that was added to the record store
);

[ public ]
SFCError GetChangesSince(
    SInt64Ptr currSeqNum          // on success, the current sequence number
    SInt64 seqNum                 // the sequence number to be used as a reference for returning changed records
    RecordIDPtr addedIDs          // on success, a list of record IDs that were added since the given seqNum
    SInt32 addedIDLen             // the number of the elements in addedIDs
    SInt32Ptr addedIDLenReq       // on success, the number of the elements that make up addedIDs
    RecordIDPtr updatedIDs        // on success, a list of record IDs that were updated since the given seqNum
    SInt32 updatedIDLen           // the number of the elements in updatedIDs
    SInt32Ptr updatedIDLenreq     // on success, the number of the elements that make up updatedIDs
    RecordIDPtr deletedIDs        // on success, a list of record IDs that were deleted since the given seqNum.
    SInt32 deletedIDLen           // the number of the elements in deletedIDs
    SInt32Ptr deletedIDLenreq     // on success, the number of the elements that make up deletedIDs
    RecordIDPtr unchangedIDs      // on success, a list of record IDs that were unchanged since the given seqNum.
    SInt32 unchangedIDLen         // the number of the elements in unchangedIDs
    SInt32Ptr unchangedIDLenreq   // on success, the number of the elements that make up unchangedIDs
);

[ public ]
SFCError GetRecord(
    RecordID id        // the unique record identifier for the record that is to be updated
    SInt32 offset      // starting offset in record sequence
    UInt08Ptr entry    // the record obtained from the record store
    SInt32 length      // the number of the elements in entry
    SInt32Ptr lenreq   // on success, the number of the elements that make up entry
);

[ public ]
SFCError GetRecord(
    RecordID id          // the unique record identifier for the record that is to be updated
    SInt32 offset        // starting offset in record sequence
    SFXBufferPtr entry   // the record obtained from the record store
);

[ public, static ]
SFBPimRecordStoreSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBPimRecordStoreSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

[ public ]
SFCError OnChange(
    SFBSignalSmpConstRef signal   // an SFBSignal object that will be set when change occurs in the record store
    ActionType action             // what type of change to monitor
    SFBQuerySmpPtr reg            // on successful completion, a registration object the caller must hold onto for as long as it wishes to be notified of changes
);

[ public ]
SFCError RemoveRecord(
    RecordID id   // the unique record identifier for the record that is to be removed
);

[ public ]
SFCError Search(
    UInt08ConstPtr criteria   // the search criterion in the format specified by the class implementation
    SInt32 length             // the number of the elements in criteria
    RecordIDPtr ids           // on success, a list of record IDs that match the given criteria
    SInt32 idLen              // the number of the elements in ids
    SInt32Ptr idLenreq        // on success, the number of the elements that make up ids
);

[ public ]
SFCError Search(
    SFXBufferConstRef criteria   // the search criterion in the format specified by the class implementation
    RecordIDPtr ids              // on success, a list of record IDs that match the given criteria
    SInt32 idLen                 // the number of the elements in ids
    SInt32Ptr idLenreq           // on success, the number of the elements that make up ids
);

[ public ]
SFCError UpdateRecord(
    RecordID id            // the unique record identifier for the record that is to be updated
    UInt08ConstPtr entry   // the record data to replace the existing record in the record store specified as a sequence of octets (8-bit bytes).
    SInt32 length          // the number of the elements in entry
);

[ public ]
SFCError UpdateRecord(
    RecordID id               // the unique record identifier for the record that is to be updated
    SFXBufferConstRef entry   // the record data to replace the existing record in the record store specified as a sequence of octets (8-bit bytes).
);

SFMTYPEDEFALIAS(pim_IRecordStoreUtil_ActionType, ActionType)

enum AliasEnum {
    EBASE               = pim_IRecordStore_EBASE,
    EINVALIDRECID       = pim_IRecordStore_EINVALIDRECID,
    EINVALIDSEQNUM      = pim_IRecordStore_EINVALIDSEQNUM,
    ESTALESEQNUM        = pim_IRecordStore_ESTALESEQNUM,
    Action_Add          = pim_IRecordStore_Action_Add,
    Action_Delete       = pim_IRecordStore_Action_Delete,
    Action_Update       = pim_IRecordStore_Action_Update,
    Action_Commit       = pim_IRecordStore_Action_Commit,
    Action_Writeable    = pim_IRecordStore_Action_Writeable,
    Action_Readable     = pim_IRecordStore_Action_Readable
};
SFMTYPEDEFTYPE(AliasEnum)

SFMTYPEDEFALIAS(pim_IRecordStoreUtil_Record, Record)

SFMTYPEDEFALIAS(pim_IRecordStoreUtil_RecordID, RecordID)

SFMTYPEDEFALIAS(pim_IRecordStoreUtil_RecordIDs, RecordIDs)

SFMTYPEDEFALIAS(pim_IRecordStoreUtil_SearchCriteria, SearchCriteria)