IPMPersist.h

//========================================================================================
// 
// $File$
// 
// Owner: Robin_Briggs
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IPMPersist__
#define __IPMPersist__

#include "IPMUnknown.h"
#include "ShuksanID.h"

class IDataBase;
class IPMStream;
class IPMPersist;
class IContentTracker;
class IContentReadIterator;
class IContentWriteIterator;
class ISnapshotCache;

class IPMPersist : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPMPERSIST };
 
 virtual UID GetUID() const = 0;

 virtual IDataBase *GetDataBase() const = 0;
 
 virtual void LoadAll(IPMStream *s, bool16 setDirty, int32 length = 0) = 0;

 virtual void SaveAll(IPMStream *s, bool16 clearDirty) = 0;


 virtual void SetDirty(IPMUnknown *p, ImplementationID prop, bool16 allowModification = kTrue) = 0;

 virtual void SetDirtyAllowDuplicateMessage(IPMUnknown *p, ImplementationID prop, bool16 allowModification = kTrue) = 0;

 virtual void SetDirtyOverrideMessage(IPMUnknown *p, PMIID overrideIID, ImplementationID prop, bool16 allowModification = kTrue) = 0;

 virtual void SetDirtyOverrideAllowDuplicateMessage(IPMUnknown *p, PMIID overrideIID, ImplementationID prop, bool16 allowModification = kTrue) = 0;



 // -----------------------------------------------------------
 // INTERNAL USE ONLY
 // -----------------------------------------------------------


 // Internal Use Only
 // Tell the object what its persistent key is. This is called
 // once from the database when an object is instantiated. 
 // It should never be called from anywhere else.
 virtual void Init(IDataBase *db, UID id) = 0;

 // Internal Use Only
 // Creates a content iterator that can be used to iterate through the 
 // data in the stream. Caller is responsible for deleting
 // @return The new iterator.
 virtual IContentReadIterator *NewReadIterator(IPMStream *s) = 0;

 // Internal Use Only
 // Creates a content iterator that can be used to iterate through the 
 // data in the object, writing to the stream. Caller is responsible 
 // for deleting
 // @return The new iterator.
 virtual IContentWriteIterator *NewWriteIterator(IPMStream *s) = 0;
 
 // Internal Use Only.
 // Load a single interface in from the stream.
 virtual void LoadOne(IPMStream *s, ImplementationID prop, IPMUnknown *loadThis, bool16 setDirty) = 0;
 
 virtual void SaveDirty(IPMStream *s, bool16 clearDirty = kTrue) = 0;
 
 // Internal Use Only
 virtual void SaveSingleInterface(InterfaceReadWrite readWriter, IPMUnknown *face, IPMStream *s, ImplementationID tag, IContentTracker *contentTracker) = 0; 
 
 // allowModification indicates whether on not to consider the pub changed (i.e. prompt the user to save).
 virtual bool16 IsDirty(const IPMUnknown *p) const = 0;
 
 // for internal use - please do not call 
 virtual void ClearDirty() = 0;

 // for internal use - please do not call 
 virtual void ResetOneToSnapshot(ImplementationID prop, SnapshotID snapshotID, ISnapshotCache* snapshotCache) = 0;

 // for internal use - please do not call 
 virtual SnapshotID SnapshotDirty (ImplementationID prop) = 0;
 // for internal use - please do not call 
 virtual void SnapshotDirty () = 0;

 // for internal use - please do not call 
 virtual void RefreshCachedLastRevInfoAfterDBClone(bool objIsReferenced) = 0;

 // for internal use - please do not call 
 virtual void UpdateReadStamps() = 0;

 // for internal use - please do not call 
 virtual void MarkDirtyInterfacesToBeCopiedAtNextMiniSave() = 0;
 
 // for internal use - please do not call
 virtual void SaveThisToComposite(IDataBase* source, IDataBase* target, UID thisUID) = 0;
};



#endif // __IPMPersist__